Cancel a pending points bucket

curl --request POST \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points/{bucketId}/cancel \
  --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>"
}

Cancel a pending points bucket

⚠️ 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.

Cancels a pending points bucket so its points are never activated, creating a PENDING_POINTS_CANCELED card transaction (status PENDING, processed asynchronously). No request body.

The program and member must be in ACTIVE status, the card definition must have pending points enabled, the bucket must be in PENDING status, and the bucket’s activation date must be in the future (423 otherwise). Returns 404 when the program, member, card or bucket does not exist.

POST

loyalties

programs

{programId}

members

{memberId}

cards

{cardId}

pending-points

{bucketId}

cancel

Error

A valid request URL is required to generate request examples

{
  "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

Pending points bucket ID (format lcppb_[a-f0-9]+).

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

Response

Result of the pending points cancellation.

Result of a pending points cancellation. This endpoint always returns status TRANSACTION_CREATED on success.

transaction

object | null

required

The created PENDING_POINTS_CANCELED card transaction, or null.

Show child attributes

status

enum<string>

required

Result status. The API endpoint returns TRANSACTION_CREATED.

Available options:

TRANSACTION_CREATED,

NO_CANCELLATION

message

string

required

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

Last modified on July 9, 2026

Activate a pending points bucket List card expiring points buckets

⌘I