Add an Apple Pay payment session

Create an Apple Pay payment session that you can invoke from the payment interface in your Toast platform integration.

Request
path Parameters
restaurantGuid
required
string <GUID>

The GUID of the restaurant that is taking a payment. The GUID is the unique identifier for the restaurant location in the Toast platform.

header Parameters
Toast-Restaurant-External-ID
required
string

The Toast platform GUID of a restaurant that is taking an Apple Pay payment.

Request Body schema: application/json

Information that the Toast platform uses to create an Apple Pay payment session that you can use to accept an Apple Pay payment in your integration ordering interface.

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.

Responses
200

Returns information about an Apple Pay payment session created by the Toast platform.

400

The request is invalid. See the response message for more information.

404

The Apple Pay payment integration does not exist.

500

An unexpected internal server error.

post/merchants/{restaurantGuid}/applepay/paymentsession
Request samples
application/json
{
  • "integrationIdentifier": "string",
  • "validationURL": "http://example.com",
  • "domain": "string",
  • "restaurantName": "string"
}
Response samples
application/json
{
  • "epochTimestamp": "2019-08-24T14:15:22Z",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "merchantSessionIdentifier": "string",
  • "nonce": "string",
  • "merchantIdentifier": "string",
  • "domainName": "string",
  • "displayName": "string",
  • "signature": "string",
  • "operationalAnalyticsIdentifier": "string",
  • "retries": "string",
  • "pspId": "string"
}