v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

Export Loyalty Card Transactions with campaign ID

Export transactions that are associated with point movements on a loyalty card.

FieldDefinitionExample Export
idUnique transaction ID assigned by Voucherify.vtx_0cb7811f1c07765800
typeTransaction type.- POINTS_EXPIRATION <br /> - POINTS_ADDITION <br /> - POINTS_REMOVAL <br /> - POINTS_TRANSFER_OUT <br /> - POINTS_ACCRUAL <br /> - POINTS_REFUND <br /> - POINTS_REDEMPTION
source_idCustom source ID of the transaction if one was included originally.source_id_custom
reasonContains the reason for the transaction if one was included originally.
balanceThe loyalty card balance after the transaction.
amountThe 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_atTimestamp in ISO 8601 format representing the date and time when the transaction was created.2022-03-09T09:16:32.521Z
voucher_idUnique Voucher ID.v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp
campaign_idParent campaign ID.camp_FNYR4jhqZBM9xTptxDGgeNBV
sourceChannel through which the transaction was initiated.- API <br /> - voucherify-web-ui <br /> - Automation
detailsMore detailed information stored in the form of a JSON.Provides more details related to the transaction in the form of an object.
related_transaction_idUnique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card.vtx_0c9afe802593b34b80
post/v1/loyalties/{campaignId}/members/{memberId}/transactions/export

Request body

Response

Returns an export object.

idstring required

Unique export ID.

object'export' required

The type of object being represented. This object stores information about the export.

created_atstring date-time required

Timestamp representing the date and time when the export was scheduled in ISO 8601 format.

status'SCHEDULED' required

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.

channelstring

The channel through which the export was triggered.

resultobject nullable required

Contains the URL of the CSV file.

user_idstring required

Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.

exported_object'voucher_transactions' required

The type of object to be exported.