Gift cards API reference
  • Gift cards API reference
    • Nothing Found
    Prerelease - gift cards API reference
    Gift cards integration specification
      Data definitions
        schema
        GiftCardTransaction
        schema
        TransactionInformation
        schema
        TransactionInformationActivate
        schema
        TransactionInformationAddValue
        schema
        TransactionInformationGetBalance
        schema
        TransactionInformationRedeem
        schema
        TransactionInformationReverse
        schema
        GiftCardTransactionResponse
        schema
        TransactionResponseActivate
        schema
        TransactionResponseAddValue
        schema
        TransactionResponseGetBalance
        schema
        TransactionResponseRedeem
        schema
        TransactionResponseReverse
      post
      Returns gift card transaction information

TransactionResponseGetBalance

Information about a gift card transaction from the gift card service provider for get balance transactions. The Toast POS system uses this information to complete guests' gift card transactions.

currentBalance
number <double>

The currency amount of the funds available from the gift card.

{
  • "currentBalance": 0
}