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.

Gift card transaction types

The following table describes the transaction types that the Toast platform sends to your gift card provider service. The Toast platform includes the transaction type identifier in the Toast-Transaction-Type header parameter for each gift card transaction API request.

Transaction type

Description

GIFTCARD_ACTIVATE

Activates a new gift card.

For example, the Toast platform sends a GIFTCARD_ACTIVATE request when it handles a gift card sale transaction.

Optional Your gift card implementation can either handle requests with this transaction type or may return a ERROR_TOAST_TRANSACTION_TYPE_NOT_SUPPORTED response status.

GIFTCARD_ADD_VALUE

Increases the amount of money available on a gift card.

For example, the Toast platform sends a GIFTCARD_ADD_VALUE request when it handles a gift card sale (initial balance) or when a restaurant guest purchases additional value to add to a gift card balance.

Optional Your gift card implementation can either handle requests with this transaction type or may return a ERROR_TOAST_TRANSACTION_TYPE_NOT_SUPPORTED response status.

GIFTCARD_GET_BALANCE

Requests the amount of money that is available for purchases on a gift card.

For example, the Toast platform sends a GIFTCARD_GET_BALANCE request when a restaurant guest asks a restaurant employee to check the amount of money that is available.

Note

In some situations, the Toast platform might send a GIFTCARD_GET_BALANCE request to verify that a gift card is not active or that it has a zero balance. For example, the Toast platform might send a GIFTCARD_GET_BALANCE request to verify that a card is not already active during a gift card sale.

Required Your gift card implementation must handle requests with this transaction type.

GIFTCARD_REDEEM

Decreases the amount of money available on a gift card.

For example, the Toast platform sends a GIFTCARD_REDEEM request when a restaurant guest makes a purchase using a gift card as a form of payment.

If the redeem request is for a cash-out transaction, the isCashOut value of the TransactionInformationRedeem object is true. In a cash-out gift card redeem transaction, the guest receives cash instead of using gift card funds for a purchase. For more information about cash-out redeem transactions, see Cash out transactions.

Optional Your gift card implementation can either handle requests with this transaction type or may return a ERROR_TOAST_TRANSACTION_TYPE_NOT_SUPPORTED response status.

GIFTCARD_REVERSE

Undoes a previous gift card transaction.

For example, the Toast platform sends a GIFTCARD_REVERSE request when a restaurant employee voids a purchase made with a gift card.

Required Your gift card implementation must handle requests with this transaction type.