Get an Apple Pay session

post /applePay/sessions

You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen's Apple Pay certificate.

The endpoint returns the Apple Pay session data which you need to complete the Apple Pay session validation.

Endpoint destination URL
Click to copy

Header parameters

Idempotency-Key string

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

Request parameters

displayName string Required

This is the name that your shoppers will see in the Apple Pay interface.

The value returned as configuration.merchantName field from the /paymentMethods response.

domainName string Required

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.

merchantIdentifier string Required

Your merchant identifier registered with Apple Pay.

Use the value of the configuration.merchantId field from the /paymentMethods response.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • Request
  • Click to copy
  • Response
  • Click to copy