You can add Alma to your existing integration. The following instructions show only what you must add to your integration specifically for Alma.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. | |
| Redirect handling | Make sure that your existing integration is set up to handle the redirect. action.type: redirect. |
|
| Setup steps | Before you begin, add Alma in your Customer Area. |
How it works
- The shopper selects Alma as the payment method.
- The shopper enters their details in the payment form that you build.
- When you make the payment request, you include additional information about the items that the shopper intends to purchase.
- Your existing integration setup will handle the redirect.
Build your payment form
Include Alma in the list of available payment methods. There are no additional fields that you have to include in your form.
You can download the logo for Alma to use in your form.
Get Alma as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Alma is included in the response.
| Parameter | Values |
|---|---|
| countryCode | FR |
| amount.currency | EUR |
Add additional parameters to your /payments request
When you make a payment, add the following parameters:
| Parameter | Required | Description |
|---|---|---|
| telephoneNumber | The shopper's telephone number. | |
| shopperEmail | The shopper's email address. | |
| billingAddress | The postal address of the shopper. | |
| deliveryAddress | The postal address where the purchased goods should be delivered. | |
| additionalData.alma.installments_count | Set to 3 or 4 to determine the number of installments the shopper will pay. Do not include if you want to let the shopper choose. |
The response includes action.type: redirect.
Test and go live
Check the status of Alma test payments in your Customer Area > Transactions > Payments.
Before you can accept live Alma payments, you need to submit a request for Alma in your live Customer Area.