--- title: "Alma iOS Component" description: "Add Alma to your Components integration." url: "https://docs.adyen.com/payment-methods/alma/ios-component" source_url: "https://docs.adyen.com/payment-methods/alma/ios-component.md" canonical: "https://docs.adyen.com/payment-methods/alma/ios-component" last_modified: "2026-05-24T12:54:31+02:00" language: "en" --- # Alma iOS Component Add Alma to your Components integration. [View source](/payment-methods/alma/ios-component.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. The additions you must make depends on the [server-side flow](/online-payments/build-your-integration) that your integration uses: ## Sessions flow Component ### Before-You-Begin ## Requirements | Requirement | Description | | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | | **Integration type** | Make sure that you have an existing Sessions flow [iOS Components integration](/online-payments/build-your-integration/sessions-flow?platform=iOS\&integration=Components). | | | **Checkout API** | Make sure that you use Checkout API v68 or later. | | | **Setup steps** | Before you begin, [add Alma in your Customer Area](/payment-methods/add-payment-methods). | | ### Add-Parameters-Sessions-Request ## Add additional parameters to your /sessions request When you [create a payment session](/online-payments/build-your-integration/sessions-flow?platform=iOS\&integration=Components#create-a-payment-session), add the following parameters: | Parameter | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------- | | [telephoneNumber](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/sessions#request-telephoneNumber) | | The shopper's telephone number. | | [shopperEmail](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/sessions#request-shopperEmail) | | The shopper's email address. | | [billingAddress](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/sessions#request-billingAddress) | | The postal address of the shopper. | | [deliveryAddress](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/session#request-deliveryAddress) | | The postal address where the purchased goods should be delivered. | **Example /sessions request** ```bash curl https://checkout-test.adyen.com/v71/sessions \ -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", "amount": { "value": 1000, "currency": "EUR" }, "returnUrl": "adyencheckout://your.package.name", "reference": "YOUR_PAYMENT_REFERENCE", "countryCode": "FR", "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" } }' ``` ### Add-Configuration ## Add additional configuration for Alma You do not need to add any configuration parameters for Alma. ### Initialize ## Initialize the Component for Alma To [initialize](#initialize-the-component) Alma, use the `InstantPaymentComponent` class. **Initialize the InstantPaymentComponent** ```swift let paymentMethods = session.sessionContext.paymentMethods // Check that the payment method is supported before showing the Component. guard let paymentMethod = paymentMethods.paymentMethod(ofType: .other("alma")) else { return } // Create an instance of InstantPaymentComponent. let component = InstantPaymentComponent(paymentMethod: paymentMethod, context: context, order: nil) self.currentComponent = component // Set the session as the delegate. component.delegate = session component.initiatePayment() ``` ## 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/). ## Advanced flow Component ### Before-You-Begin ## Requirements | Requirement | Description | | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | | **Integration type** | Make sure that you have an existing Advanced flow [iOS Components integration](/online-payments/build-your-integration/advanced-flow?platform=iOS\&integration=Drop-in). | | | **Action handling** | Make sure that your existing integration is set up to [handle the additional action](/online-payments/build-your-integration/advanced-flow/?platform=iOS\&integration=Components#handle-the-redirect). `action.type`: ****redirect****. | | | **Setup steps** | Before you begin, [add Alma in your Customer Area](/payment-methods/add-payment-methods). | | ### Add-Configuration ## Add additional configuration for Alma You do not need to add any configuration parameters for Alma. ### Initialize ## Initialize the Component for Alma To [initialize](#initialize-the-component) Alma, use the `InstantPaymentComponent` class. **Initialize the InstantPaymentComponent** ```swift // Check that the payment method is supported before showing the Component. guard let paymentMethod = paymentMethods.paymentMethod(ofType: .other("alma")) else { return } // Create an instance of InstantPaymentComponent. let component = InstantPaymentComponent(paymentMethod: paymentMethod, context: context, order: nil) self.currentComponent = component // Set the Component as the delegate. component.delegate = self component.initiatePayment() ``` ### Add-Parameters-Payments-Request ## Add additional parameters to your /payments request When you [make a payment](/online-payments/build-your-integration/advanced-flow/?platform=iOS\&integration=Components#make-a-payment), add the following parameters to the [/payments](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) request: | 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 the `action.type`: redirect. **Example response with an additional 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/).