Mystery giftCard and giftCardInfo fields
Answered
I'm receiving a copy of a Toast check via a LOYALTY_ACCRUE transaction. The check has the following payment information:
"payments": [
{
"amount": 2.0,
"amountTendered": 0.0,
"cardEntryMode": null,
"cardPaymentId": null,
"cardType": null,
"cashDrawer": null,
"checkGuid": "cd158f49-f828-4243-ae72-b40f19c39029",
"createdDevice": {
"id": "c4d7e074e10b9300"
},
"entityType": "OrderPayment",
"externalId": null,
"giftCard": null,
"giftCardInfo": null,
"guid": "7735ca31-c033-4e0d-bda5-cf7dd079fb7d",
"houseAccount": null,
"last4Digits": null,
"lastModifiedDevice": {
"id": "c4d7e074e10b9300"
},
"mcaRepaymentAmount": null,
"orderGuid": "1d3b5765-8e22-4772-9cc4-5684af535977",
"originalProcessingFee": null,
"otherPayment": null,
"paidBusinessDate": 20210815,
"paidDate": "2021-08-15T17:47:57.122+0000",
"paymentStatus": "AUTHORIZED",
"referenceCode": null,
"refund": null,
"refundStatus": "NONE",
"tipAmount": 2.0,
"type": "GIFTCARD",
"voidInfo": null
}
]
This check was payed by a gift card ("type": "GIFTCARD") and I see these giftCard and giftCardInfo fields that aren't populated. I don't see these fields mentioned anywhere in the documentation (https://dev.toasttab.com/Ie5QH/apiLoyaltyIntegrationApiReference.html#/definitions/Payment) and I'm curious what they're for and when they might be not null.
-
Hi Jonathan!
You've found an example of a time when our loyalty spec is out of sync with our orders spec, which is something we're working on resolving (i.e. allowing the two specs to sync automatically). The check submitted on loyalty transactions is the same as the check returned in the orders API, so if there is ever missing info on the loyalty spec, it can often be found in the orders spec.
In this case, the GiftCardInfo object within the Payment object does not currently return any data; these fields are present for possible future projects.
0
Please sign in to leave a comment.
Comments
1 comment