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.

Redeem discounts and payments

After the Toast platform applies payments to the check, the discounts and payments are redeemed. For more information about gratuity payments, see Gratuity.

Redeem discounts and payments workflow

  1. The Toast platform sends a TENDER_REDEEM request to the PMS provider.

  2. The PMS provider marks the discounts as used and adds the payment to the guest's account.

  3. The restaurant employee closes the check if the full amount is covered by the room charge.

Redeem discounts and payments request body

{
  "discountsTransactionInformation":null,
  "paymentsTransactionInformation":null,
  "redeemTransactionInformation": {
    "tenderIdentifier": "2670f8d0-c9c1-4dd1-b234-6922a81a7792",
    "orderGuid": "04ade72f-28c9-441c-a197-16d42c4c8f84",
    "check":{
        ...
        "payments": [
{
"amount": 2.11,
"amountTendered": null,
"cardEntryMode": null,
"cardHolderFirstName": null,
"cardHolderLastName": null,
"cardPaymentId": null,
"cardType": null,
"cashDrawer": null,
"checkGuid": null,
"createdDevice": null,
"entityType": null,
"externalId": null,
"giftCard": null,
"giftCardInfo": null,
"guid": "b1727f60-a5ce-4391-9ed6-e37e8a92f1b9",
"houseAccount": null,
"isProcessedOffline": null,
"last4Digits": null,
"lastModifiedDevice": null,
"mcaRepaymentAmount": null,
"orderGuid": null,
"originalProcessingFee": null,
"otherPayment": null,
"paidBusinessDate": null,
"paidDate": null,
"paymentStatus": "PROCESSING",
"receiptToken": null,
"referenceCode": null,
"refund": null,
"refundStatus": "NONE",
"server": null,
"tipAmount": 0.0,
"type": "OTHER",
"voidInfo": null
}
        ...
    },
      "tenderPaymentsApplied": [
            {
                "name": "Tender Payment",
                "identifier": "b1727f60-a5ce-4391-9ed6-e37e8a92f1b9",
                "type": "STORED_VALUE",
                "amount": 2.11,
                "tipAmount": 0.0,
                "paymentGuid":"af10f95f-9ee7-4975-933d-afa2cf6806e2"
            }
    ],
      "tenderDiscountsApplied": [
            {
                "name": "Tender Discount",
                "identifier": "0e557a20-b36d-4be4-9367-221d3d082780",
                "amount": 4.0,
                "selectionGuid":null,
                "appliedDiscountGuid":"26595a7b-9ad9-497a-aa45-4539989e10a2"
            },
            {
                "name":"Tender Discount",
                "identifier":"31d6cdf2-e766-4754-8759-f8a0f17aa9cf",
                "amount":5.00,
                "selectionGuid":"145071fe-ef70-4dda-a9ce-520bde54abca",
                "appliedDiscountGuid":"6b11b9d2-7a3e-4b52-9c74-b451e41ec306"
            }
 
    ]
  },
  "gratuityTransactionInformation":null,
  "reverseTransactionInformation":null
}

Successful redeem discounts and payments response

{
    "transactionStatus": "ACCEPT"
}