---
title: "Alma for API only"
description: "Add Alma to your API-only integration."
url: "https://docs.adyen.com/payment-methods/alma/api-only"
source_url: "https://docs.adyen.com/payment-methods/alma/api-only.md"
canonical: "https://docs.adyen.com/payment-methods/alma/api-only"
last_modified: "2026-06-01T15:33:15+02:00"
language: "en"
---

# Alma for API only

Add Alma to your API-only integration.

[View source](/payment-methods/alma/api-only.md)

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](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only).                                                                   |   |
| **Redirect handling** | Make sure that your existing integration is set up to [handle the redirect](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#handle-the-redirect). `action.type`: **redirect**. |   |
| **Setup steps**       | Before you begin, [add Alma in your Customer Area](/payment-methods/add-payment-methods).                                                                                                                                  |   |

## How it works

1. The shopper selects Alma as the payment method.
2. The shopper enters their details in the [payment form that you build](#build-your-payment-form).
3. When you make the payment request, you [include additional information about the items that the shopper intends to purchase](#additional-parameters-payments).
4. Your existing integration setup will [handle the redirect](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#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](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%2Bonly\&version=71#downloading-logos) to use in your form.

## Get Alma as an available payment method

When you make the [/paymentMethods](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods) to [get available payment methods](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#get-available-payment-methods), specify the following so that Alma is included in the response.

| Parameter                                                                                                          | Values  |
| ------------------------------------------------------------------------------------------------------------------ | ------- |
| [countryCode](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-countryCode)         | **FR**  |
| [amount.currency](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#request-amount-currency) | **EUR** |

**Example request for available payment methods**

```bash
curl https://checkout-test.adyen.com/v72/paymentMethods \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'idempotency-key: YOUR_IDEMPOTENCY_KEY' \
-H 'content-type: application/json' \
-X POST
-d '{
   "merchantAccount": "ADYEN_MERCHANT_ACCOUNT",
   "countryCode": "FR",
   "amount": {
      "currency": "EUR",
	  "value": 1000
   },
   "shopperLocale": "fr-FR"
}'
```

**Example response with Alma available**

```json
{
    "paymentMethods": [
        {
            "name": "Alma",
            "type": "alma"
        }
    ]
}
```

## Add additional parameters to your /payments request

When you [make a payment](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only#make-a-payment), add the following parameters:

| Parameter                                                                                                                           | Required | Description                                                                                                                           |
| ----------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| [telephoneNumber](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/payments#request-telephoneNumber)                    |          | The shopper's telephone number.                                                                                                       |
| [shopperEmail](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/payments#request-shopperEmail)                          |          | The shopper's email address.                                                                                                          |
| [billingAddress](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/payments#request-billingAddress)                      |          | The postal address of the shopper.                                                                                                    |
| [deliveryAddress](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/payments#request-deliveryAddress)                    |          | The postal address where the purchased goods should be delivered.                                                                     |
| [additionalData.alma.installments\_count](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#request-additionalData) |          | 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. |

**Example payment request for Alma**

```bash
curl https://checkout-test.adyen.com/v72/payments \
-H 'x-API-key: ADYEN_API_KEY' \
-H 'idempotency-key: YOUR_IDEMPOTENCY_KEY' \
-H 'content-type: application/json' \
-X POST
-d '{
  "amount":{
    "currency":"EUR",
    "value":1000
  },
  "reference":"YOUR_ORDER_NUMBER",
  "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
  "merchantAccount":"ADYEN_MERCHANT_ACCOUNT",
  "countryCode": "FR",
  "shopperLocale": "en-US",
  "telephoneNumber": "85121212121",
  "shopperEmail": "s.hopper@gmail.com",
  "billingAddress": {
                      "city": "Paris",
                      "country": "FR",
                      "houseNumberOrName": "123",
                      "postalCode": "2000",
                      "street": "Happy Street"
                     },
  "deliveryAddress": {
                      "city": "Paris",
                      "country": "FR",
                      "houseNumberOrName": "123",
                      "postalCode": "2000",
                      "street": "Happy Street"
                     },
  "additionalData":  {
                      "alma.installments_count": 4
                     }
}'
```

The response includes `action.type`: **redirect**.

**Example response with a redirect action**

```json
{
    "resultCode":"RedirectShopper",
    "action":{
        "paymentMethodType":"alma",
        "method":"GET",
        "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
        "type":"redirect"
    }
}
```

## Test and go live

Check the status of Alma test payments in your [Customer Area](https://ca-test.adyen.com/) > **Transactions** > **Payments**.

Before you can accept live Alma payments, you need to [submit a request for Alma](/payment-methods/add-payment-methods) in your [live Customer Area](https://ca-live.adyen.com/).

## See also

* [API-only integration guide](/online-payments/build-your-integration/advanced-flow/?platform=Web\&integration=API%20only)
