Understanding the guest reporting data

Guest reporting data contains objects for each payment corresponding to the specified restaurants and payment dates. You can also choose to retrieve data for currently inactive restaurants. For more information, see Viewing inactive restaurant data.

The restaurants included in the guest reporting data can be limited using either the restaurantIds or excludedRestaurantIds value in the message body. You can include restaurant GUIDs for only one of these values. Any restaurants listed with the restaurantIds value are included in the guest reporting data, with any restaurants not listed excluded. Any restaurants listed with the excludedRestaurantIds value are excluded from the guest reporting data, with any restaurants not listed included. When both are left blank, all restaurants are included automatically.

The following table specifies the returned set of values in the guest reporting data. The values are listed in the order they appear.

Value name

Definition

restaurantGuid

The unique identifier assigned to the restaurant by the Toast platform.

restaurantName

The restaurant’s name.

restaurantLocationName

The restaurant’s location name.

restaurantLocationCode

The restaurant’s location code.

paymentDate

The date when the payment was processed, in YYYYMMDD format.

orderGuid

The unique identifier assigned to the order by the Toast platform.

paymentGuid

The unique identifier assigned to the payment by the Toast platform.

cardFingerprint

The unique identifier assigned to a guest's payment card by the Toast platform.

Note

cardFingerprint data is only available for payments processed starting in August 2024. cardFingerprint data is not supported for older payments.

cardLast4Digits

The last four digits of a guest's payment card number.

Note

cardFingerprint data is only available for payments processed starting in August 2024.

cardType

The guest's payment card brand type. For example, MASTERCARD or VISA.

paymentAccountReference

The Payment Account Reference (PAR) assigned by the card network to identify a payment card account across different payment tokens and processors.

The PAR is 29 characters. The first four characters are the bank identification number (BIN) controller identifier associated with the card network. The remaining 25 characters are a unique combination of alphanumeric characters.

This is currently only available for payment processing companies that support PAR. A null value is returned when the payment processor does not support PAR or for payments processed before PAR was enabled.

Note

paymentAccountReference data is only available for payments processed starting on July 30, 2026.