Programs

List card expiring points buckets

Changed on

Returns a cursor-paginated list of ACTIVE point expiration buckets for the member's card. Each bucket groups points that share an expiration date and expiration type, including points from separate transactions.

The list starts on the current project day. Earlier buckets are omitted.

Results can be filtered by card definition ID and expiration date, and ordered by expiration_date.

Returns an empty list when the card has no matching buckets. Returns 400 when the query is invalid or the cursor is invalid, expired, or doesn't match the query. Returns 404 when the program or the member doesn't exist, or when the card isn't assigned to that member.

get/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Query parameters

limitinteger nullable

Limits the page size to an integer from 1 to 100. Defaults to 10. A numeric string is accepted and rounded to the nearest integer.

string[]
OR
'expiration_date' | '-expiration_date'

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to expiration_date. Soonest expiration first. The same field cannot be used in both directions. Rows with the same sort value are then ordered by id ascending.

cursorstring nullable

Continues pagination. Pass the cursor.next value from a previous response. Format lcrspeb_[a-f0-9]+. The cursor matches the filters and order of that response.

junction'AND' | 'OR' nullable

Joins the field filters. Allowed values are AND and OR. Defaults to AND.

Filters the results. Pass a deep object, for example filters[card_definition_id][conditions][$is]=lcdef_1297339938ae248cea. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Cursor-paginated list of points expiration buckets.

object'list' required

Object type marker, always list.

Changes

  • v24134cde57cdaRevision changes
    • breaking

      removed the required property /////// from the response with the status

    • info

      added the required property ////////// to the response with the status

  • v20d886da710c9Revision changes
    • breaking

      removed the required property ////////// from the response with the status

    • info

      added the required property /////// to the response with the status