ApplePayPaymentSessionRequest

Information used to create an Apple Pay payment session.

domain
required
string

The internet domain name that the guest uses to submit an Apple Pay payment. Must match a domain included in the domains that you register for your Apple Pay payment integration.

integrationIdentifier
required
string

The unique identifier of an Apple Pay payment integration registered with the Toast platform.

restaurantName
required
string

The name of the restaurant location that is taking the payment.

validationURL
required
string <uri>

The Apple Pay gateway URL. For example, you can use the following gateway validationURL.

https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession

The validation URL should be any of the valid URLs provided by Apple for the Global Region.

Note: do not submit non-production or China region URLs.

{
  • "integrationIdentifier": "string",
  • "validationURL": "http://example.com",
  • "domain": "string",
  • "restaurantName": "string"
}