Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Gift Cards

Find gift card

Finds and returns the given card number. Returns a 404 if the card does not exist.

Within the gift card structure returned is the field gift__card__transactions which contains a list of all the transactions associated with the gift card. In this list you will see one or more of the following statuses:

  • "ACTIVATION" - This transaction type is added automatically when the gift card is created. The amount will be the initial balance that was loaded onto the gift card.
  • "REDEEMING" - This status indicates the customer used their gift card to pay for one or more items. The amount MUST be negative.
  • "IMPORTING" - You should only see this if gift cards were imported into the gift card system.
  • "VOIDING" - You will see this status if the gift card has been voided. Note that the balance of the card is set to zero when the gift card is voided.
  • "EXPIRING" - This transaction is added automatically when the gift card expires. Again note that the balance is set to zero when the gift card expires.
  • "REVERSING" - This status indicates that a given transaction was reversed.
  • "RELOADING" - This status means that more credit was loaded onto the gift card.

🔒 Requires: gift_cards:read scope

get/gift_cards/{number}

Path parameters

numberstring required

The number of the gift card to find.

Response

Gift card successfully retrieved.

balancestring

The balance of the gift card, represented as a string for precision.

created_atstring

The creation timestamp in UTC.

expires_atstring nullable

The expiry timestamp in UTC.

idstring

Auto-generated object ID.

numberstring

The gift card number.

sale_idstring nullable

The ID of the sale associated with the gift card creation, if it was created through a register sale. Null if the gift card was created directly via the API.

sale_sourcestring

The source system where the gift card was created (e.g. x-series, e-series).

status'ACTIVE' | 'INACTIVE' | 'REDEEMED' | 'VOIDED' | 'EXPIRED'

The gift card status.

total_redeemedstring

The amount redeemed with this gift card, represented as a string for precision.

total_soldstring

The amount loaded onto this gift card during activation or reloading, represented as a string for precision.