ADadyen
Utility

Get an Apple Pay session

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.

post/applePay/sessions

Request

  • Base URL
    https://checkout-test.adyen.com/v69
  • URL
    https://checkout-test.adyen.com/v69/applePay/sessions
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Headers

Idempotency-Keystring

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

Request body

displayNamestring 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.

domainNamestring 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.

merchantIdentifierstring required

Your merchant identifier registered with Apple Pay.

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

Response

OK - the request has succeeded.

datastring required

Base64 encoded data you need to complete the Apple Pay merchant validation.

Changes

No recorded changes to this operation across all 51 revisions of this API.