Get the guest reporting data organized by payment

Returns the guest data organized by payment for the reporting data request.

Specify the reportRequestGuid for the reporting data.

Securityoauth2
Request
path Parameters
reportRequestGuid
required
string

The Toast platform identifier for the reporting data request.

Responses
200

The reporting data.

202

The Toast platform is in the process of gathering the reporting data. Try the request again at a later time.

404

An unexpected error occurred. Refer to the message attached to this error for more information.

409

The Toast platform was unable to process the request. Request a new reportRequestGuid and try again.

500

An unexpected internal error occurred. The requestId attached to this error can be referenced by the Toast support team.

504

The Toast platform was unable to process the request because internal services took too long to process, resulting in a timeout.

get/guest/payments/{reportRequestGuid}
Request samples
curl -i -X GET \
  'https://toast-api-server/era/v1/guest/payments/{reportRequestGuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "restaurantGuid": "string",
  • "restaurantName": "string",
  • "restaurantLocationName": "string",
  • "restaurantLocationCode": "string",
  • "paymentDate": "string",
  • "orderGuid": "string",
  • "paymentGuid": "string",
  • "cardFingerprint": "string"
}