Get an Apple Pay integration's information

Retrieve information about your Apple Pay integration including the integrationIdentifier, integrationName, and registered domains.

Request
path Parameters
integrationIdentifier
required
string <GUID>

The unique identifier of an Apple Pay payment integration registered with 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.

Responses
200

Returns information about an Apple Pay payment integration.

403

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

404

The Apple Pay payment integration does not exist.

get/applepay/integration/{integrationIdentifier}
Request samples
curl -i -X GET \
  'https://toast-api-server/ccpartner/v1/applepay/integration/{integrationIdentifier}' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "integrationIdentifier": "string",
  • "integrationName": "string",
  • "domains": [
    ]
}