Unregister an Apple Pay domain

Unregister a domain registered to take Apple Pay payments.

Request
header Parameters
Toast-Restaurant-External-ID
required
string

Specify the GUID of a restaurant whose domain you want to unregister.

Request Body schema: application/json

Information about the domains you want to unregister from your Apple Pay integration.

domains
required
Array of strings
integrationIdentifier
required
string

The unique identifier of your Apple Pay payment integration. The Toast platform generates this identifier and registers it with Apple.

reason
string

Custom reason for unregistering the domain. This is optional.

Responses
200

Returns a list of unregistered domains. If all domains have been unregistered, the messsage field shows a Registration was successfully deleted. message.

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.

404

The Apple Pay payment integration does not exist.

500

An unexpected internal server error.

put/applepay/unregisterIntegration
Request samples
application/json
{
  • "integrationIdentifier": "string",
  • "domains": [
    ],
  • "reason": "string"
}
Response samples
application/json
{
  • "domains": [
    ],
  • "message": "string"
}