Payment-method icon

Alma Component

Add Alma to an existing Components integration.

On this page, you can find additional configuration for adding Alma to your Components integration.

Before you begin

This page assumes you have already:

API reference

When making a /sessions request, you can optionally 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.

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="alma-container"></div>

Step 2: Create an instance of the Component

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const almaComponent = checkout.create('alma').mount('#alma-container');

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.