Transactions
You can track the history of transactions on gift cards and loyalty cards to review and create reports.
Contents
Transactions Overview
Transactions contain the operations on loyalty cards and gift cards, providing you with details on each card. Details can be viewed and exported individually, per card, or per campaign through the Transactions tab within the General section of the selected Loyalty Program or Gift Card campaign.
Gift Card
The gift card transactions which can be monitored are:
- Redemption: When credits are used to pay for an order.
- Refund: When funds are credited back to a card through a redemption rollback.
- Addition: When funds are deposited to a gift card.
- Removal: When funds are removed from a gift card.
Loyalty Card
The loyalty card transactions that can be monitored are:
- Accrual: When points are earned on the card through an earning rule.
- Redemption: When points are used to pay for an order using pay-with-points.
- Refund: When points are credited back to a card through a redemption rollback.
- Addition: When points are added to a card.
- Removal: When points are removed from a card.
- Expiration: When points expire.
- Transfer: When points are transferred from one loyalty card to another.
Campaign Transactions
The Transactions tab within the General section of the loyalty program or gift card's campaign dashboard lists all transactions. This feature lets users view transaction details and export transaction data to a CSV file.
Each transaction entry includes the following details:
- Card: Identifies the card associated with the transaction.
- Type: Specifies the transaction type (e.g., points redemption, points addition).
- Related Loyalty Card: Lists any associated cards (only in loyalty campaigns).
- Source ID: The unique identifier for the transaction source.
- Reason: User's description of the purpose of the transaction.
- Amount: Shows the points used or acquired.
- Balance: Displays the current balance on the card after the transaction.
- Created At: Timestamp indicating when the transaction was created.
- Details: contains API response details that provide in-depth information for each transaction, including balance adjustments (
type
,total
,points
,operation_type
), associated objects (such as related cards, order, and redemption IDs), and reward specifics (e.g., reward ID and name).
This feature enables transaction management by consolidating transaction data into a single view and simplifying data extraction for reporting or auditing purposes.
Exporting
You can export transactions using the export tool. The following fields are available to be exported:
Gift Card
Export field | Definition | Example |
---|---|---|
Id |
Unique transaction ID assigned by Voucherify. |
vtx_0c94f018d30bef6689 |
Type |
Type of transaction. |
CREDITS_ADDITION |
Source ID |
Custom source ID of the transaction. | |
Reason |
Contains the reason for the transaction if one was included originally. | |
Balance |
The gift card balance after the transaction. | |
Amount |
The amount of gift card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | 100 |
Creation Date |
Timestamp in ISO 8601 indicating when the transaction occurred. | 2023-03-10T18:38:02.055Z |
Voucher ID |
Unique voucher ID that is assigned by Voucherify. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |
Campaign ID |
Voucher's parent campaign's unique ID assigned by Voucherify. | camp_FNYR4jhqZBM9xTptxDGgeNBV |
Source |
Channel through which the transaction was initiated. | voucherify-web-ui |
Details |
More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |
Loyalty Card
Export field | Definition | Example |
---|---|---|
Id |
Unique transaction ID assigned by Voucherify. |
vtx_0c94f018d30bef6689 |
Type |
Type of transaction. |
POINTS_ACCRUAL |
Source ID |
Custom source ID of the transaction if one was included originally. | |
Reason |
Contains the reason for the transaction if one was included originally. | |
Balance |
The loyalty card balance after the transaction. | 200 |
Amount |
The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | 100 |
Creation Date |
Timestamp in ISO 8601 indicating when the transaction occurred. | 2023-03-10T18:38:02.055Z |
Voucher ID |
Unique voucher ID that is assigned by Voucherify. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |
Campaign ID |
Voucher's parent campaign's unique ID assigned by Voucherify. | camp_FNYR4jhqZBM9xTptxDGgeNBV |
Details |
More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |
Related Transaction ID |
Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |