This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
Send a GET
request to the
/payments/
endpoint of the
orders API to obtain detailed information about a specific payment. The
endpoint returns a {guid}
Payment
object that contains information
about the payment. For information about the values of the
Payment
object, see the reference
documentation for the orders API.
The following example curl command sends a
GET
request to the
/payments/
endpoint for a
specific payment.
{guid}
Get Information of a Specific Payment
curl -X GET \ -H "Authorization: Bearer eyJzI1NiJ9hbGciOiJSU.eyJhd9yaXR5Ij oiQ1JVTkNIVElNRSIsInJzR3VpZCI6IjE4YzQ5YWJlLWFlODItNGFlYy04ND M1LWJhYTRjMjVlYTY2MiIsInNjb3BlIjpbImxWQiOlsidG9hc3QiXSwibmFt aW5nQXV0aGhYm9yIiwib3JkZXJzIiwidXNlcm1nbXQiXSwiZXhwIjoxNDg0M zg5ODUwLCJqdGkiOiJlMDYzZjJkMy1jNGYyLTRiZjItODJmNi01MTg1NWMzZ DAxM2YiLCJjbGllbnRfaWQiOiJjcnVuY2h0aW1lIn0.X1_0y9Hzj5F9gdOw2 o6VSYTyZwooAJiFMDmNakbZrtiUdYwLzuLwLpCMQzX5pKYtOqDUz_cetGJL3 txKL1L-K2j1Enoq8An8hEM6e8J0KdAiwrYFO3W3CmWedaoz95K9ghNZVCs28 Td2Sp3Ix3fObxbrvanocx9_OT8S9uM8hdSXmBI_ykTWvOVgK4hO24V3DJy4b 9bz1FtgOvrClhELxCe8dJy7jiwAR60xczlCF5rna98RMLN6zY4ffjmljKFZ6 QV0KkVppWjEiJn7oFHiIylCX1sSg7sddrGatj0xJzts3GJ8u8_lryUNHaEvJ dWq4Yzwo007AMgxjH9d241Y-g" \ -H "Toast-Restaurant-External-ID: 76cb1b05-cb1e-4adf-863a-b2a94a5ecdcf" \https://
[toast-api-hostname]
/orders/v2/payments/361d140a-aa0b-43ad-98d6-516c416555d9
The following example shows the JSON response data for a GET request
to the /payments/
endpoint.
The payment method for this sample payment was a credit card.
{guid}
Get Payment Return Data
{ "guid": "361d140a-aa0b-43ad-98d6-516c416555d9","entityType": "OrderPayment", "externalId": null, "originalProcessingFee": null, "amount": 57.73,
"tipAmount": 0,
"amountTendered": 0, "cashDrawer": null, "cardType": "VISA", "lastModifiedDevice": { "id": "7c664bbbb33913bd" }, "refundStatus": "NONE", "houseAccount": null,
"type": "CREDIT",
"voidInfo": null,
"otherPayment": null,
"mcaRepaymentAmount": null, "createdDevice": { "id": "7c664bbbb33913bd" }, "paidDate": "2020-02-11T16:38:32.774+0000",
"cardEntryMode": "KEYED",
"paymentStatus": "CAPTURED",
"paidBusinessDate": 20200211, "last4Digits": "1111", "refund": null,
"orderGuid": "86675d88-b27e-4850-94ab-48662563eae8", "checkGuid": "ed4b222f-5259-43fd-8db0-1243a11ed554" }
The |
|
The amount of the payment, including taxes and service charges but excluding tips. |
|
The amount tipped on this payment. |
|
If a house account was used to pay the check, this value
contains reference information (such as the GUID) of the house
account. The value is |
|
The payment method, such as |
|
If the payment was voided, this value contains a
|
|
Reference information (such as the GUID) of an other payment
option used to pay the check. The value is |
|
The date and time when the payment was made. |
|
For credit card payments, specifies how the credit card data
was obtained. The value is |
|
The status of the payment. In this example, the payment has been captured. |
|
If the payment has been refunded, this value contains a
|
The following sections provide information about voided and refunded payments.