Get payment identifiers

Returns a list of the GUIDs for each payment made during one restaurant business day.

The specific hours that make up a business day depend on the business day cutoff in the restaurant configuration, which is available from the restaurants API in the closeoutHour property.

The business day for a restaurant is based on its local time (not UTC or local time for an API client).

You must include one of the paidBusinessDate, refundBusinessDate, or voidBusinessDate query parameters.

Securityoauth2
Request
query Parameters
paidBusinessDate
string

Returns a list of the payments that were made during one business day.

Specify the business day in the format yyyyMMdd. For example, 20170101.

refundBusinessDate
string

Returns a list of the payments that were refunded during one business day.

Specify the business day in the format yyyyMMdd. For example, 20170101.

voidBusinessDate
string

Returns a list of the payments that were voided during one business day.

Specify the business day in the format yyyyMMdd. For example, 20170101.

header Parameters
Toast-Restaurant-External-ID
required
string

The GUID of the restaurant used as the context of the request.

Responses
200

A JSON array of the GUID identifiers for the payments.

400

The API cannot process the request.

get/payments
Request samples
curl -i -X GET \
  'https://toast-api-server/orders/v2/payments?paidBusinessDate=string&refundBusinessDate=string&voidBusinessDate=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • "string"
]