Gift Card Transactions: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. This can be a helpful jumping off point as you plan your implementation.

Query a gift card's complete transaction history

Retrieve the full history of balance changes for a specified gift card when managing gift cards for customer service or reporting. This flow retrieves all transactions ordered by creation date.

To query a gift card's complete transaction history, follow these steps:

1. Call Query Gift Cards to retrieve gift cards and their IDs.

2. Call Query Gift Card Transactions with the gift card ID:

3. Process the transactions array in the response. Each transaction includes the amount, type, and updatedBalance after the transaction is applied.

Filter transactions by type for reports

Analyze specified transaction types when generating reports. For example, filter to show only REDEEM transactions to understand gift card usage patterns.

To filter transactions by type, follow these steps:

1. Call Query Gift Card Transactions with a filter for the desired transaction type:

   Copy

2. Process the transactions in the response, which now contain only redemption records.

3. To analyze refunds instead, change the filter value to "PAYMENT_METHOD_REFUND".