curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/members/{memberId}/transactions \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "vtx_0c9dd3c2e392f78613",
"source_id": "20230317_transfer_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "API",
"reason": "Transferring points to card",
"type": "POINTS_TRANSFER_OUT",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1396,
"object": "balance",
"points": -1,
"balance": 1396,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"destination_voucher": {
"id": "v_Wak6xlf5WdR4rIcvJxC2olOopk0boK6t",
"code": "LOYALTY-CARD-A8XVurg",
"type": "LOYALTY_CARD",
"campaign": "Loyalty Campaign - Test Initial Points",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"loyalty_card": {
"points": 1102,
"balance": 1102,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 102
},
"is_referral_code": false
}
},
"related_transaction_id": "vtx_0c9dd3c2e392f78614",
"created_at": "2023-03-17T16:20:33.807Z"
},
{
"id": "vtx_0c9dd2527696ba081b",
"source_id": "20230317_add_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": "Adding points to card",
"type": "POINTS_ADDITION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1397,
"object": "balance",
"points": 100,
"balance": 1397,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-17T16:14:16.524Z"
},
{
"id": "vtx_0c9dd1ce1d403f4204",
"source_id": "20230317_subtract_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": "Subtracting points from card",
"type": "POINTS_REMOVAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1297,
"object": "balance",
"points": -1,
"balance": 1297,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-17T16:12:00.981Z"
},
{
"id": "vtx_0c9c21df658d03ce3f",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "Automation",
"reason": null,
"type": "POINTS_ACCRUAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1298,
"object": "balance",
"points": 200,
"balance": 1298,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_QZEKPzYATFjGoos4DonMg0fd",
"source_id": "s"
},
"event": {
"id": "evcus_0c9c21def34e3c05bf",
"type": "customer.order.paid"
},
"earning_rule": {
"id": "ern_2WsCIBEx6Lzf5IAV5IOR7a23",
"source": {
"banner": "Order paid"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-16T08:44:52.333Z"
},
{
"id": "vtx_0c9b09673f8a862a51",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": null,
"type": "POINTS_REFUND",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": 1000,
"balance": 1098,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_DH2gGDlDWB1hRImf1VVB4EIH",
"source_id": null
},
"redemption": {
"id": "r_0c9b08fe4b80897849"
},
"rollback": {
"id": "rr_0c9b0967244a862a33"
},
"reward": {
"id": "rew_INt3fGH3n7xIr3ZQcq4kkUZ1",
"name": "100 = $20"
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:19:29.149Z"
},
{
"id": "vtx_0c9b08fe530089785c",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": null,
"type": "POINTS_REDEMPTION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": -1000,
"balance": 98,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_DH2gGDlDWB1hRImf1VVB4EIH",
"source_id": null
},
"redemption": {
"id": "r_0c9b08fe4b80897849"
},
"reward": {
"id": "rew_INt3fGH3n7xIr3ZQcq4kkUZ1",
"name": "100 = $20"
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:17:41.708Z"
},
{
"id": "vtx_0c9b074afed3b30e4b",
"source_id": "20230309_add_points_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "voucherify-web-ui",
"reason": "Customer purchased points at kiosk.",
"type": "POINTS_ADDITION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": 100,
"balance": 1098,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:10:15.917Z"
},
{
"id": "vtx_0c9b073072408969d1",
"source_id": "20230309_subtract_points_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "voucherify-web-ui",
"reason": "Customer used points to obtain tickets.",
"type": "POINTS_REMOVAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 998,
"object": "balance",
"points": -1,
"balance": 998,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:09:48.735Z"
},
{
"id": "vtx_0c9afe802593b34b80",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "API",
"reason": null,
"type": "POINTS_TRANSFER_OUT",
"details": {
"balance": {
"type": "loyalty_card",
"total": 999,
"object": "balance",
"points": -1,
"balance": 999,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"destination_voucher": {
"id": "v_Wak6xlf5WdR4rIcvJxC2olOopk0boK6t",
"code": "LOYALTY-CARD-A8XVurg",
"type": "LOYALTY_CARD",
"campaign": "Loyalty Campaign - Test Initial Points",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"loyalty_card": {
"points": 1001,
"balance": 1001,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 1
},
"is_referral_code": false
}
},
"related_transaction_id": "vtx_0c9afe802593b34b81",
"created_at": "2023-03-15T11:31:51.062Z"
}
],
"has_more": true,
"more_starting_after": "vtx_0c9afe802593b34b80"
}Retrieve transaction data related to point movements for a specific loyalty card.
curl --request GET \
--url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/members/{memberId}/transactions \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "vtx_0c9dd3c2e392f78613",
"source_id": "20230317_transfer_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "API",
"reason": "Transferring points to card",
"type": "POINTS_TRANSFER_OUT",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1396,
"object": "balance",
"points": -1,
"balance": 1396,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"destination_voucher": {
"id": "v_Wak6xlf5WdR4rIcvJxC2olOopk0boK6t",
"code": "LOYALTY-CARD-A8XVurg",
"type": "LOYALTY_CARD",
"campaign": "Loyalty Campaign - Test Initial Points",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"loyalty_card": {
"points": 1102,
"balance": 1102,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 102
},
"is_referral_code": false
}
},
"related_transaction_id": "vtx_0c9dd3c2e392f78614",
"created_at": "2023-03-17T16:20:33.807Z"
},
{
"id": "vtx_0c9dd2527696ba081b",
"source_id": "20230317_add_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": "Adding points to card",
"type": "POINTS_ADDITION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1397,
"object": "balance",
"points": 100,
"balance": 1397,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-17T16:14:16.524Z"
},
{
"id": "vtx_0c9dd1ce1d403f4204",
"source_id": "20230317_subtract_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": "Subtracting points from card",
"type": "POINTS_REMOVAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1297,
"object": "balance",
"points": -1,
"balance": 1297,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-17T16:12:00.981Z"
},
{
"id": "vtx_0c9c21df658d03ce3f",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "Automation",
"reason": null,
"type": "POINTS_ACCRUAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1298,
"object": "balance",
"points": 200,
"balance": 1298,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_QZEKPzYATFjGoos4DonMg0fd",
"source_id": "s"
},
"event": {
"id": "evcus_0c9c21def34e3c05bf",
"type": "customer.order.paid"
},
"earning_rule": {
"id": "ern_2WsCIBEx6Lzf5IAV5IOR7a23",
"source": {
"banner": "Order paid"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-16T08:44:52.333Z"
},
{
"id": "vtx_0c9b09673f8a862a51",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": null,
"type": "POINTS_REFUND",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": 1000,
"balance": 1098,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_DH2gGDlDWB1hRImf1VVB4EIH",
"source_id": null
},
"redemption": {
"id": "r_0c9b08fe4b80897849"
},
"rollback": {
"id": "rr_0c9b0967244a862a33"
},
"reward": {
"id": "rew_INt3fGH3n7xIr3ZQcq4kkUZ1",
"name": "100 = $20"
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:19:29.149Z"
},
{
"id": "vtx_0c9b08fe530089785c",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": null,
"reason": null,
"type": "POINTS_REDEMPTION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": -1000,
"balance": 98,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"order": {
"id": "ord_DH2gGDlDWB1hRImf1VVB4EIH",
"source_id": null
},
"redemption": {
"id": "r_0c9b08fe4b80897849"
},
"reward": {
"id": "rew_INt3fGH3n7xIr3ZQcq4kkUZ1",
"name": "100 = $20"
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:17:41.708Z"
},
{
"id": "vtx_0c9b074afed3b30e4b",
"source_id": "20230309_add_points_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "voucherify-web-ui",
"reason": "Customer purchased points at kiosk.",
"type": "POINTS_ADDITION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 1098,
"object": "balance",
"points": 100,
"balance": 1098,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:10:15.917Z"
},
{
"id": "vtx_0c9b073072408969d1",
"source_id": "20230309_subtract_points_1",
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "voucherify-web-ui",
"reason": "Customer used points to obtain tickets.",
"type": "POINTS_REMOVAL",
"details": {
"balance": {
"type": "loyalty_card",
"total": 998,
"object": "balance",
"points": -1,
"balance": 998,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2023-03-15T12:09:48.735Z"
},
{
"id": "vtx_0c9afe802593b34b80",
"source_id": null,
"voucher_id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"source": "API",
"reason": null,
"type": "POINTS_TRANSFER_OUT",
"details": {
"balance": {
"type": "loyalty_card",
"total": 999,
"object": "balance",
"points": -1,
"balance": 999,
"related_object": {
"id": "v_lWRrcwNm0vqxBaU5nsSMzRRHusCsS4Vl",
"type": "voucher"
}
},
"destination_voucher": {
"id": "v_Wak6xlf5WdR4rIcvJxC2olOopk0boK6t",
"code": "LOYALTY-CARD-A8XVurg",
"type": "LOYALTY_CARD",
"campaign": "Loyalty Campaign - Test Initial Points",
"campaign_id": "camp_LyAZf94hbZaUbSdKIeAJpjRp",
"loyalty_card": {
"points": 1001,
"balance": 1001,
"next_expiration_date": "2023-12-31",
"next_expiration_points": 1
},
"is_referral_code": false
}
},
"related_transaction_id": "vtx_0c9afe802593b34b81",
"created_at": "2023-03-15T11:31:51.062Z"
}
],
"has_more": true,
"more_starting_after": "vtx_0c9afe802593b34b80"
}The access token received from the authorization server in the OAuth 2.0 flow.
A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
"camp_rRsfatlwN7unSeUIJDCYedal"
A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
"MmFAzfDe"
Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
1 <= x <= 100Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
id, -id Filters for listing member transactions. id is the unique identifier of the transaction.
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Value is after this date. The value for this parameter is shown in the ISO 8601 format.
"2024-01-01T00:00:00.000Z"
Value is before this date. The value for this parameter is shown in the ISO 8601 format.
"2024-01-01T00:00:00.000Z"
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value is more days ago before the current date and time, e.g. more than 10 days ago.
Value is less days before the current date and time, e.g. less than 10 days ago.
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.
Returns a dictionary of loyalty card transaction objects.
Response body schema for GET v1/loyalties/{campaignId}/members/{memberId}/transactions and /loyalties/members/{memberId}/transactions.
The type of the object represented by JSON.
list Identifies the name of the attribute that contains the array of transaction objects.
data A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object.
Show child attributes
Unique transaction ID.
The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.
Unique voucher ID.
Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.
The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.
Reason why the transaction occurred. In case of a redemption, this value is null.
The related transaction ID on the receiving card.
Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.
Contains the detailed information about the transaction.
Show child attributes
Contains information on how the balance was affected by the transaction.
Show child attributes
The number of all points or credits accumulated on the card as affected by add or subtract operations.
The type of the object represented by the JSON.
balance The available points or credits on the card after the transaction as affected by redemption or rollback.
Defines the resource that is being modified with the values that are returned in the balance object.
The type of voucher whose balance is being adjusted due to the transaction.
loyalty_card, gift_voucher Credits added or subtracted on a gift card.
Points added or subtracted in the transaction of a loyalty card.
The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.
MANUAL, AUTOMATIC Contains information about the original order.
Show child attributes
Contains information about the earning rule.
Show child attributes
Unique identifier of an earning rule, assigned by Voucherify.
Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.
Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed.
Contains details about the pending point entry.
Show child attributes
Unique identifier of the pending point entry, assigned by Voucherify.
"lopp_0ffd593d5ad207ba6b"
Unique identifier of the loyalty card, assigned by Voucherify.
"v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc"
Unique campaign identifier, assigned by Voucherify.
"camp_weer1c3p5ZgktqfW56RfoNaG"
Unique customer identifier, assigned by Voucherify.
"cust_IdgAFZxYwwHctOk9ppZMu319"
Unique order identifier, assigned by Voucherify.
"ord_0ffc0fa65f15d2df17"
Number of points in the pending state.
Date when the pending points are activated and added to the customer's loyalty card.
Details about how the pending points were earned.
Show child attributes
Details about the event that created pending points.
Show child attributes
Unique event identifier, assigned by Voucherify.
Type of the event that triggered the creation of pending points.
customer.order.paid Unique identifier of the request that triggered the event, assigned by Voucherify.
Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the customer_id of the customer who paid for the order.
Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.
Type of the event.
ACTION, EFFECT Contains the source of the object that initiated the event.
Show child attributes
Determines the channel that initiated the event.
USER_PORTAL, API, CLIENT_API, INTERNAL "API"
Determines the API key used to initiate the event.
Show child attributes
Channel name in the application keys.
Contains the application ID from the Voucherify API key pair.
"1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX"
Contains information about the earning rule.
Show child attributes
Unique identifier of an earning rule, assigned by Voucherify.
Contains the custom earning rule name.
Show child attributes
Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
The loyalty tier that is mapped for the earning rule and used in the pending point transaction.
Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.
Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.
Contains information on how the balance on the donor loyalty card was affected by the transaction.
Show child attributes
Voucher code.
Type of the voucher.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
The type of the object represented by JSON.
voucher A unique identifier that represents the voucher assigned by Voucherify.
Gift object response.
Show child attributes
Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. balance = amount - subtracted_amount - redemption.redeemed_amount.
Total amount of subtracted credits over the gift card lifetime.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Contains information about discount.
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the loyalty card details. Simplified loyalty card data.
Show child attributes
Total number of points added to the loyalty card over its lifespan.
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
The next closest date when the next set of points are due to expire.
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
Campaign name.
Campaign unique ID.
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
Unique identifier of the category that this voucher belongs to.
"cat_0b6152ce12414820dc"
Contains details about the category.
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
"2022-07-14T10:45:13.156Z"
Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
"2022-08-16T10:52:08.094Z"
Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.
Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Defines the redemption limits on vouchers.
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total loyalty points redeemed.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Contains information on how the balance on the receiving loyalty card was affected by the transaction.
Show child attributes
Voucher code.
Type of the voucher.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Timestamp representing the date and time when the order was created in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
The type of the object represented by JSON.
voucher A unique identifier that represents the voucher assigned by Voucherify.
Gift object response.
Show child attributes
Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. balance = amount - subtracted_amount - redemption.redeemed_amount.
Total amount of subtracted credits over the gift card lifetime.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Contains information about discount.
Show child attributes
Defines the type of the voucher.
AMOUNT Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the loyalty card details. Simplified loyalty card data.
Show child attributes
Total number of points added to the loyalty card over its lifespan.
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
The next closest date when the next set of points are due to expire.
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
Campaign name.
Campaign unique ID.
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
Unique identifier of the referrer assigned by Voucherify.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
Unique identifier of the category that this voucher belongs to.
"cat_0b6152ce12414820dc"
Contains details about the category.
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
"2022-07-14T10:45:13.156Z"
Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
"2022-08-16T10:52:08.094Z"
Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.
Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Defines the redemption limits on vouchers.
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total loyalty points redeemed.
Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.
"2021-12-01T00:00:00.000Z"
Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
"2021-12-31T00:00:00.000Z"
A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
Transaction types concerning loyalty points.
PENDING_POINTS_ACTIVATION, POINTS_ACCRUAL, POINTS_REDEMPTION, POINTS_REFUND, POINTS_ADDITION, POINTS_REMOVAL, POINTS_EXPIRATION, POINTS_TRANSFER_IN, POINTS_TRANSFER_OUT As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.
Returns an ID that can be used to return another page of results. Use the transaction ID in the starting_after_id query parameter to display another page of the results starting after the transaction with that ID.
Was this page helpful?