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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Idempotency-Key String No

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

Request body fields

Name Type Required Description
merchantIdentifier String Yes

Your merchant identifier registered with Apple Pay.

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

displayName String Yes

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 Yes

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.