Skip to main content
POST
/
EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED
{
  "customer": {
    "id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "name": "Alex Doe",
    "email": null,
    "source_id": "4lx-d03",
    "metadata": {},
    "object": "customer"
  },
  "campaign": {
    "id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
    "name": "Loyalty program",
    "campaign_type": "LOYALTY_PROGRAM",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "LOYALTY_CARD",
      "discount": null,
      "gift": null,
      "loyalty_card": {
        "points": 0
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "pattern": "########",
        "length": 8,
        "charset": "0123456789",
        "prefix": "",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": true,
    "active": true,
    "category_id": null,
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": null,
    "created_at": "2025-01-07T12:44:10.211Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
    "code": "67028386",
    "loyalty_card": {
      "points": 23,
      "balance": 23,
      "pending_points": 23
    },
    "type": "LOYALTY_CARD",
    "campaign": "Loyalty program",
    "campaign_id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
    "is_referral_code": false,
    "holder_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "category_id": null,
    "active": true,
    "created_at": "2025-01-07T12:44:11.371Z",
    "updated_at": "2025-01-08T14:10:48.300Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0,
      "redeemed_points": 0
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "voucher_pending_points_balance": {
    "points": -23,
    "total": 23,
    "object": "balance",
    "related_object": {
      "type": "voucher",
      "id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v"
    },
    "operation_type": "MANUAL"
  },
  "order": {
    "id": "ord_0ff3476ebb49a3901d",
    "source_id": null,
    "status": "PAID",
    "customer_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "referrer_id": null,
    "amount": 500,
    "total_amount": 500,
    "items": [
      {
        "id": "ordli_0ff3476ebac9a3901b",
        "object": "order_item",
        "product_id": "prod_0fc35dfeabcdefeb80",
        "quantity": 1,
        "amount": 500,
        "price": 500,
        "subtotal_amount": 500
      },
      {
        "id": "ordli_0ff3476ebac9a3901c",
        "object": "order_item",
        "product_id": "prod_5h1pp1ng",
        "quantity": 1,
        "amount": 0,
        "price": 0,
        "subtotal_amount": 0
      }
    ],
    "metadata": {
      "card": [
        "Other"
      ],
      "region": "US",
      "currency": "USD"
    },
    "created_at": "2025-01-08T13:50:17.318Z",
    "object": "order"
  },
  "redemption": null,
  "pending_points": {
    "id": "lopp_0ff49105b988dd5c8f",
    "voucher_id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
    "campaign_id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
    "customer_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "order_id": "ord_0ff3476ebb49a3901d",
    "points": 23,
    "activates_at": "2025-01-09",
    "details": {
      "event": {
        "id": "evcus_0ff3476ebf89a39027",
        "type": "customer.order.paid",
        "group_id": "v-0ff3476eb50dfac446",
        "entity_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
        "created_at": "2025-01-08T13:50:17.319Z",
        "category": "EFFECT",
        "event_source": {
          "channel": "USER_PORTAL",
          "user": {
            "id": "user_ypzfEcSAphSONMGJRlj6trzXKsh7FGX7"
          }
        }
      },
      "earning_rule": {
        "id": "ern_vjzc7A2IHoCUbl5lyO6kyJQM",
        "source": {
          "banner": "Here come your loyalty points"
        }
      },
      "order": {
        "id": "ord_0ff3476ebb49a3901d",
        "source_id": null
      }
    },
    "created_at": "2025-01-08T13:50:17.680Z"
  }
}

Response

200 - application/json

Indicates that pending points were canceled for a loyalty card.

Event data object schema for voucher.loyalty_card.pending_points.canceled.

​
customer
object
required

Simplified customer data.

​
campaign
object
required

Simplified campaign data.

​
voucher
object
required

Simplified voucher data.

​
voucher_pending_points_balance
object
required

Contains information on how the balance was affected by the transaction.

​
order
object
required

Order information.

​
pending_points
object
required

Contains details about the pending point entry.

⌘I