Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Alma Redirect Component

Add Alma to an existing Components integration.

You don't need to collect any information from your shopper in your payments form. If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to their bank's website or app where they can complete the payment.

When making a alma payment, you need to:

Before you begin

This page explains how to add Alma to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your alma integration:

  1. Make sure that you have set up your back end implementation for making API requests.
  2. Add Alma in your test Customer Area.

Show Alma in your payment form

Include alma in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

  1. Specify in your /paymentMethods request:

The response contains paymentMethod.type: alma.

We provide logos for alma and the issuing banks which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

When the shopper proceeds to pay, you need to:

  1. From your server, make a /payments request, specifying:

    • paymentMethod.type: Set this to alma.
    • returnURL: URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

    You can also include the following fields, so that the shopper doesn't have to fill in this information on the Alma-hosted page:

    Parameter name 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.
    curl https://checkout-test.adyen.com/v68/payments \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
      "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
      "reference":"YOUR_ORDER_NUMBER",
      "amount":{
        "currency":"EUR",
        "value":1000
      },
      "paymentMethod":{
        "type":"alma"
      },
      "countryCode": "FR",
      "shopperLocale": "en-US",
      "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
    }'
    # Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen::Client.new
    adyen.api_key = "YOUR_X-API-KEY"
     
    response = adyen.checkout.payments({
      :amount => {
        :currency => "EUR",
        :value => 1000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "alma"
      },
      :countryCode => "FR",
      :shopperLocale => "en-US",
      :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
      :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
    })
    // Set YOUR_X-API-KEY with the API key from the Customer Area.
    // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
        Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
        Checkout checkout = new Checkout(client);
    
        PaymentsRequest paymentsRequest = new PaymentsRequest();
    
        String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
        paymentsRequest.setMerchantAccount(merchantAccount);
    
        Amount amount = new Amount();
        amount.setCurrency("EUR");
        amount.setValue(15000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("alma");
        paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
        paymentsRequest.setReference("YOUR_ORDER_NUMBER");
        paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
        paymentsRequest.setCountryCode("FR");
        paymentsRequest.setShopperLocale("en-US");
    
        PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    $client = new \Adyen\Client();
    $client->setXApiKey("YOUR_X-API-KEY");
    $service = new \Adyen\Service\Checkout($client);
    
    $params = array(
      "amount" => array(
        "currency" => "EUR",
        "value" => 1000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "alma"
      ),
      "countryCode" => "FR",
      "shopperLocale" => "en-US",
      "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
      "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
    );
    $result = $service->payments($params);
    #Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen.Adyen()
    adyen.client.xapikey = 'YOUR_X-API-KEY'
    
    result = adyen.checkout.payments({
       'amount': {
          'value': 1000,
          'currency': 'EUR'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'alma'
       },
       'countryCode': 'FR',
       'shopperLocale': 'en-US',
       'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
       'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
    })
    // Set your X-API-KEY with the API key from the Customer Area.
    var client = new Client ("YOUR_X-API-KEY", Environment.Test);
    var checkout = new Checkout(client);
    
    var amount = new Model.Checkout.Amount("EUR", 1000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "alma"
    };
    var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
      MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
      PaymentMethod = details,
      CountryCode = "FR",
      ShopperLocale = "en-US"
    };
    
    var paymentResponse = checkout.Payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
    const config = new Config();
    // Set your X-API-KEY with the API key from the Customer Area.
    config.apiKey = '[API_KEY]';
    config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
    const client = new Client({ config });
    client.setEnvironment("TEST");
    const checkout = new CheckoutAPI(client);
    checkout.payments({
        amount: { currency: "EUR", value: 1000 },
        paymentMethod: {
            type: 'alma'
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount,
        countryCode: "FR",
        shopperLocale: "en-US",
        returnUrl: "https://your-company.com/checkout?shopperOrder=12xy.."
    }).then(res => res);

    The /payments response contains an action object with the information needed to redirect the shopper.

    /payments response
    {
    "resultCode":"RedirectShopper",
    "action":{
      "paymentMethodType":"alma",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
    }
    }
  1. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

  1. Use the Redirect Component to redirect the shopper to Alma's website where they can provide their account details. When the shopper returns back to your app, the Redirect Component provides the actionComponentData object.

  2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

    • details: The actionComponentData.details object from the Redirect Component.

    /payments/details request
    curl https://checkout-test.adyen.com/v68/payments/details \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
     "details": {
       "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
    }
    }'

You receive a response containing:

  • resultCode: Use this to present the payment result to your shopper.
  • pspReference: Our unique identifier for the transaction.

/payments/details response
{
      "resultCode": "Authorised",
      "pspReference": "PPKFQ89R6QRXGN82"
}

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

You will also receive the outcome of the payment asynchronously in a notification webhook.

The resultCode values you can receive for Alma are:

resultCode Description Action to take
Authorised The shopper completed their payment, and it has been sent to the bank for processing. In most cases, this means that you will receive the funds. If you are using manual capture, you also need to capture the payment. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or
Received
The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION notification.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for Alma are:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.

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.

See also