Skip to main content
POST
/
v2
/
loyalties
/
programs
/
{programId}
/
members
/
{memberId}
/
cards
/
{cardId}
/
expiring-points
/
{bucketId}
/
expire
Expire a points bucket
curl --request POST \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points/{bucketId}/expire \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "transaction": {
    "id": "<string>",
    "card_id": "<string>",
    "program_id": "<string>",
    "member_id": "<string>",
    "card_definition_id": "<string>",
    "card_type": "INDIVIDUAL",
    "details": {
      "reason": "<string>",
      "rejection": {
        "reason": "<string>",
        "details": "<string>"
      },
      "metadata": {},
      "points": {
        "total": 123,
        "expiration_date": "2023-12-25",
        "date": "2023-12-25"
      },
      "bucket": {
        "id": "<string>",
        "points": {
          "total": 123
        },
        "expiration_date": "2023-12-25"
      },
      "buckets": [
        {
          "id": "<string>",
          "points": {
            "total": 123
          },
          "expiration_date": "2023-12-25"
        }
      ],
      "date": "2023-12-25",
      "reward": {
        "id": "<string>"
      },
      "reward_transaction": {
        "id": "<string>"
      },
      "card_transaction": {
        "id": "<string>"
      },
      "purchase": {
        "card_transaction": {
          "id": "<string>"
        },
        "reward_transaction": {
          "id": "<string>"
        }
      },
      "order": {
        "id": "<string>"
      },
      "order_transaction": {
        "id": "<string>"
      },
      "target_card": {
        "id": "<string>"
      },
      "purchase_transaction": {
        "id": "<string>"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "object": "<string>"
  },
  "message": "<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>"
}
{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Path Parameters

​
programId
string
required

Loyalty program ID (format lprg_[a-f0-9]+).

Pattern: ^lprg_[a-f0-9]+$
​
memberId
string
required

Program member ID (format lmbr_[a-f0-9]+).

Pattern: ^lmbr_[a-f0-9]+$
​
cardId
string
required

Loyalty card ID (format lcrd_[a-f0-9]+).

Pattern: ^lcrd_[a-f0-9]+$
​
bucketId
string
required

Points expiration bucket ID (format lcpeb_[a-f0-9]+).

Pattern: ^lcpeb_[a-f0-9]+$

Response

Result of the points expiration.

Result of a manual points bucket expiration. This endpoint always returns status TRANSACTION_CREATED on success.

​
transaction
object | null
required

The created ADMIN_POINTS_EXPIRATION card transaction, or null.

​
status
enum<string>
required

Result status. The API endpoint returns TRANSACTION_CREATED.

Available options:
TRANSACTION_CREATED,
NO_EXPIRATION
​
message
string
required

Human-readable result message - "Points expiration transaction created".

Last modified on July 9, 2026