Add or update an Apple Pay integration

Add or update an Apple Pay payment integration for use with Toast platform payments. You use the registered integration to accept guests' Apple Pay payments.

Request
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 about an Apple Pay payment integration used for taking Toast platform payments.

If the integrationIdentifier identifier that the Toast platform generates based on the id and integrationName values in the body parameter is not already registered with Apple for Apple Pay payments, the Toast platform will create a new Apple Pay payment integration record with your information. If the integrationIdentifier matches an existing integration record, the Toast platform will update the information about that integration using the other values in the body parameter you send.

domains
required
Array of strings
id
required
string <uuid>

A unique identifier for your Apple Pay payment integration. The Toast platform includes this string in the identifier that it generates and registers for your integration with the Apple Pay service.

You set the UUID identifier for your integration. To prevent accidental duplicate identifiers, the Toast platform concatenates the id value with the integrationName value to generate the registered identifier.

integrationName
required
string

A human-readable business name associated with the Apple Pay payment integration. For example, this might be the name of a restaurant management group if the Apple Pay payment integration is for a restaurant management group ordering integration.

The Toast platform concatenates the integrationName value with the id value to generate the identifier that it registers with the Apple Pay service.

userEmail
required
string <email>

The email contact information for the Apple Pay payment integration.

Responses
201

The Toast platform created the Apple Pay payment integration identified by the id and integrationName values in your request. The response includes the integrationIdentifier in the message body.

204

The Toast platform updated the Apple Pay payment integration identified by the id and integrationName values in your request. The response does not include a body parameter.

304

Registration not modified. The response does not include a message body.

400

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

403

Your API client is not authorized to access the Apple Pay payment integration.

422

The message body of the request did not contain all of the required values or contained unexpected values.

500

An unexpected internal server error.

put/applepay/registration
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "domains": [
    ],
  • "userEmail": "user@example.com",
  • "integrationName": "string"
}
Response samples
application/json
"string"