Export transactions that are associated with point movements on a loyalty card.
| Field | Definition | Example Export |
|---|---|---|
| id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 |
| type | Transaction type. | - POINTS_EXPIRATION - POINTS_ADDITION - POINTS_REMOVAL - POINTS_TRANSFER_OUT - POINTS_ACCRUAL - POINTS_REFUND - POINTS_REDEMPTION |
| source_id | Custom source ID of the transaction if one was included originally. | source_id_custom |
| reason | Contains the reason for the transaction if one was included originally. | |
| balance | The loyalty card balance after the transaction. | |
| 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. | |
| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |
| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |
| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |
| source | Channel through which the transaction was initiated. | - API - voucherify-web-ui - Automation |
| 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 |
The access token received from the authorization server in the OAuth 2.0 flow.
A unique code identifying the loyalty card that you are looking to export transaction data for.
"MmFAzfDe"
Specify the parameters and filters for the transaction export.
Request body schema for POST v1/loyalties/members/{memberId}/transactions/export and for POST v1/loyalties/{campaignId}/members/{memberId}/transactions/export.
List of available fields and filters that can be exported with an order along with the sorting order of the returned data.
Returns an export object.
Response body schema for POST v1/loyalties/members/{memberId}/transactions/export and for POST v1/loyalties/{campaignId}/members/{memberId}/transactions/export.
Unique export ID.
The type of object being represented. This object stores information about the export.
export Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.
SCHEDULED Contains the URL of the CSV file.
Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.
The type of object to be exported.
voucher_transactions The channel through which the export was triggered.
List of available fields and filters that can be exported with an order along with the sorting order of the returned data.