SchemaPaymentsApple Pay Sessions

Start Apple Pay session

Use this method to start an Apple Pay session for your merchant. In the response, we return the startSessionObject that you send to Apple when you retrieve the cardholder’s encrypted payment details.

Path parameters

processingTerminalIdstringRequired>=4 characters<=50 characters

Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
appleDomainIdstringRequired

Unique identifier of the merchant’s domain that we assigned when you added their domain to our Self-Care Portal.

appleValidationUrlstringRequired

Validation URL from the Apple Pay JS API.

Response

Successful request. We started the Apple Pay session.

startSessionResponsestring

Object that Apple returns when they start the merchant’s Apple Pay session. Use this object to retrieve the cardholder’s encrypted payment details from Apple.