A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"card_id": "<string>",
"customer_id": "<string>",
"card_definition_id": "<string>",
"program_id": "<string>",
"card_type": "INDIVIDUAL",
"member_id": "<string>",
"points": {
"total": 123
},
"expiration_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}List card expiring points buckets
⚠️ BETA endpoint
This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.
Returns a cursor-paginated list of points expiration buckets of the member’s card.
Each bucket groups active points sharing the same expiration date and expiration
type. Results can be ordered by expiration_date. Returns 404 when the program,
member or card does not exist.
curl --request GET \
--url {protocol}://{host}/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"data": [
{
"id": "<string>",
"card_id": "<string>",
"customer_id": "<string>",
"card_definition_id": "<string>",
"program_id": "<string>",
"card_type": "INDIVIDUAL",
"member_id": "<string>",
"points": {
"total": 123
},
"expiration_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Loyalty program ID (format lprg_[a-f0-9]+).
^lprg_[a-f0-9]+$Program member ID (format lmbr_[a-f0-9]+).
^lmbr_[a-f0-9]+$Loyalty card ID (format lcrd_[a-f0-9]+).
^lcrd_[a-f0-9]+$Query Parameters
Maximum number of buckets to return. Must be between 1 and 100. Defaults to 10 when not provided.
1 <= x <= 100Field(s) to order results by. Valid orders are expiration_date and
-expiration_date; defaults to expiration_date (soonest expiration first).
Ordering by the same field in both directions simultaneously is rejected.
expiration_date, -expiration_date Pagination cursor returned in the cursor.next field of a previous response.
Must match the pattern ^lcrspeb_[a-f0-9]+$.
^lcrspeb_[a-f0-9]+$Response
Cursor-paginated list of points expiration buckets.
Cursor-paginated list of points expiration buckets.
Was this page helpful?