Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
/
members
/
{memberId}
/
transactions
List Loyalty Card Transactions
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"
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

campaignId
string
required

A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

memberId
string
required

A unique code identifying the loyalty card that you are looking to retrieve transaction data for.

Example:

"MmFAzfDe"

Query Parameters

limit
integer

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.

Required range: 1 <= x <= 100
order
enum<string>

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options:
id,
-id
filters
object

Filters for listing member transactions. id is the unique identifier of the transaction.

starting_after_id
string

A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID.

Response

200 - application/json

Returns a dictionary of loyalty card transaction objects.

Response body schema for GET v1/loyalties/{campaignId}/members/{memberId}/transactions and /loyalties/members/{memberId}/transactions.

object
enum<string>
default:list
required

The type of the object represented by JSON.

Available options:
list
data_ref
enum<string>
default:data
required

Identifies the name of the attribute that contains the array of transaction objects.

Available options:
data
data
Loyalty Card Transaction · object[]
required

A dictionary that contains an array of transactions. Each entry in the array is a separate transaction object.

has_more
boolean
required

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.

more_starting_after
string

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.

I