Get an Apple Pay session

POST/applePay/sessions

Use it in a workflow

Add a step and choose the Adyen connector.
Pick the Get an Apple Pay session action (under Utility).
Fill in the fields below, then reference the result from later steps as {{getAnApplePaySession.response.data}}.

Request

Headers

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body

Enter the body as JSON in the step's Body field.

displayNamestringrequired

This is the name that your shoppers will see in the Apple Pay interface. The value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.

domainNamestringrequired

The domain name you provided when you added Apple Pay in your Customer Area. This must match the `window.location.hostname` of the web shop.

merchantIdentifierstringrequired

Your merchant identifier registered with Apple Pay. Use the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.

json

{
  "displayName": "string",
  "domainName": "string",
  "merchantIdentifier": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{getAnApplePaySession.response.data.<field>}}.

datastring

Base64 encoded data you need to [complete the Apple Pay merchant validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).

json

{
  "data": "string"
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Was this page helpful?