About the Gift Card Transactions API

The Gift Card Transactions API retrieves the transaction history for a specific gift card. Every change to a gift card's balance creates a transaction record, providing a complete audit trail of all gift card activity.

Use this API alongside the Gift Cards API for comprehensive gift card management.

With the Gift Card Transactions API, you can:

  • Retrieve the full transaction history for any gift card.
  • Filter transactions by transaction type, date, or operation type.
  • Sort and paginate through large transaction histories.
  • Track balance changes over time for reporting and auditing.

Before you begin

Before you start coding, note the following:

  • You need a valid gift card ID to query its transactions. Call Query Gift Cards to retrieve gift cards and their IDs.
  • You can't modify or delete transactions. The system automatically creates them when a gift card's balance changes.

Transaction types

Each transaction has a type that indicates the reason for the balance change:

  • REDEEM: The gift card is used to pay for a purchase. This subtracts from the balance.
  • VOID: A previous redemption is canceled, restoring the gift card balance.
  • INITIAL: The initial value is assigned when the gift card is created.
  • PAYMENT_METHOD_REFUND: A refund is processed, adding value back to the gift card.
  • MANUAL: A manual adjustment was made.

Use cases

Terminology

  • Transaction: A record representing a single change to a gift card's balance. You can use transactions to audit gift card activity, track balance changes over time, and support reporting.
  • Operation type: Indicates whether a transaction adds value (ADD) or subtracts value (SUBTRACT) from the gift card balance.
  • Updated balance: The gift card's balance after the transaction is applied.
  • Order info: Details about the eCommerce order when the transaction is related to a purchase or refund.
Did this help?