Programs

List card pending point buckets

Changed on

Returns a cursor-paginated list of pending point buckets for the member's card. Every bucket has status PENDING. Pending points wait for activation (PERIOD_BASED, FIXED_DATES, or EVENT_BASED), following the card definition.

The list starts on the next project day. The current day's bucket is omitted because it's still accumulating.

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

Returns 404 when the program or the member doesn't exist, or when the card isn't assigned to that member.

Bucket IDs from this list are the bucketId for Activate pending point bucket and Cancel pending point bucket.

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

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-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
'date' | '-date'

Orders the results. Accepts one value or an array. Prefix a field with - for descending order. Defaults to date. Soonest activation 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 lcrscppb_[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_128f495f720c4bec8c. Fields combine through junction, which defaults to AND. Omit filters to apply no field filter.

Response

Cursor-paginated list of pending point 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