Create session for Apple Pay transaction

Creates a session for an Apple Pay transaction. The session is used to validate the merchant and initiate the payment process with Apple Pay.

SecurityBearerAuth or OAuth2
Request
Request Body schema: application/json
domain
required
string

The internet domain name used to submit an Apple Pay payment. The domain must match a domain you registered for your Apple Pay payment integration.

paymentMethodDomainId
string or null <uuid>

The identifier of the merchant domain. You can retrieve the paymentMethodDomainId from the Toast developer portal.

sessionSecret
string or null

A unique and randomized identifier for the payment intent.

validationURL
required
string <uri>

The Apple Pay gateway URL.

Responses
200

Successful operation. Apple Pay session created.

400

Bad request / Missing required fields.

403

Your Toast API client does not have permission to create an Apple Pay session.

500

Internal server error.

post/digital-wallet-broker/v1/wallets/apple-pay/payment-session
Request samples
application/json
{
  • "validationURL": "http://example.com",
  • "domain": "string",
  • "paymentMethodDomainId": "d57daa6c-5384-431c-962f-a1b7551fbf49",
  • "sessionSecret": "string"
}
Response samples
application/json
"string"