Get an alternative payment type

Returns an AlternatePaymentType object containing information about an alternative form of payment configured for a restaurant. Alternate payment types are forms of payment that are not standard in the Toast POS and that are configured for a particular restaurant. For example, a third-party service that processes payments might be configured as an alternate payment type.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The Toast POS GUID of the alternative form of payment.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The Toast POS GUID of the restaurant that the alternate payment type is configured for.

Responses

200

Returns an AlternatePaymentType object.

get /alternatePaymentTypes/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/config/v2/alternatePaymentTypes/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "entityType": "string",
  "externalId": "string",
  "name": "string"
}