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.

Refunded Payments

The /payments/{guid} endpoint can return data for refunded payments. A refund is a credit card payment that has been fully reversed after it was captured. Refunds cannot be issued on specific items, but instead can only be issued on the entire check.

In the return data for a refunded payment, the Payment object includes a Refund object with details of the refund operation.

The following example shows the JSON response data for a refunded credit card payment.

Example of a Refunded Payment

{
  "guid": "3e95fde2-da0f-4057-b91c-840b43e637c5",
  "entityType": "OrderPayment",
  "externalId": null,
  "originalProcessingFee": null,
  "amount": 6.36,
  "tipAmount": 0.0,
  "amountTendered": 6.36,
  "cashDrawer": null,
  "cardType": "VISA",
  "lastModifiedDevice": {
    "id": null
  },
  "refundStatus": "FULL",1
  "houseAccount": null,
  "type": "CREDIT",
  "voidInfo": null,
  "otherPayment": null,
  "mcaRepaymentAmount": null,
  "createdDevice": {
    "id": null
  },
  "paidDate": "2020-02-19T19:47:51.206+0000",2
  "cardEntryMode": "ONLINE",
  "paymentStatus": "CAPTURED",
  "paidBusinessDate": 20200219,
  "last4Digits": "1111",
  "refund": {3
    "refundAmount": 6.36,4
    "tipRefundAmount": 0.0,5
    "refundDate": "2020-02-19T19:48:31.828+0000",6
    "refundBusinessDate": 202002197
  }
}

1

The status of the refund. A FULL status means that a full refund was made on this payment.

2

The date and time when the original (pre-refund) payment was made.

3

The Refund object with details of the refund.

4

The amount of the refund, excluding the tip.

5

The amount of the tip refund.

6

The date and time when the payment was refunded.

7

The business date when the payment was refunded.