{"title":"Alma for API only","category":"default","creationDate":1776961628,"content":"

You can add Alma to your existing integration. The following instructions show only what you must add to your integration specifically for Alma.<\/p>\n

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.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Redirect handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the redirect<\/a>.
action.type<\/code>: redirect<\/strong>.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add Alma in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects Alma as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n
  4. Your existing integration setup will handle the redirect<\/a>.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include Alma in the list of available payment methods. There are no additional fields that you have to include in your form.<\/p>\n

    \n

    You can download the logo for Alma<\/a> to use in your form.<\/p>\n<\/div>\n

    Get Alma as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> to get available payment methods<\/a>, specify the following so that Alma is included in the response.<\/p>\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nFR<\/strong><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nEUR<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    When you make a payment<\/a>, add the following parameters:<\/p>\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    telephoneNumber<\/a><\/td>\n<\/td>\nThe shopper's telephone number.<\/td>\n<\/tr>\n
    shopperEmail<\/a><\/td>\n<\/td>\nThe shopper's email address.<\/td>\n<\/tr>\n
    billingAddress<\/a><\/td>\n<\/td>\nThe postal address of the shopper.<\/td>\n<\/tr>\n
    deliveryAddress<\/a><\/td>\n<\/td>\nThe postal address where the purchased goods should be delivered.<\/td>\n<\/tr>\n
    additionalData.alma.installments_count<\/a><\/td>\n<\/td>\nSet to 3<\/code> or 4<\/code> to determine the number of installments the shopper will pay. Do not include if you want to let the shopper choose.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n

    The response includes action.type<\/code>: redirect<\/strong>.<\/p>\n

    \n <\/code-sample>\n<\/div>\n

    Test and go live<\/h2>\n

    Check the status of Alma test payments in your\u00a0Customer Area<\/a>\u00a0>\u00a0Transactions<\/strong>\u00a0>\u00a0Payments<\/strong>.<\/p>\n

    Before you can accept live Alma payments, you need to submit a request for Alma<\/a> in your live Customer Area<\/a>.<\/p>\n

    See also<\/h2>\n