post https://example.com/EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED
EVENT: "EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED"
HTTP method: POST
HTTP method: POST
The EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED event indicates that loyalty pending points have been successfully canceled for a customer's loyalty card associated with a voucher. The pending points can be canceled manually with the POST Cancel Member Pending Points endpoint.
This event is triggered by distribution – Loyalty pending points canceled.
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.
Example: customer.voucher.loyalty card.pending points.canceled
{
"customer": {
"id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"name": "Jack Webhook",
"email": null,
"source_id": "jck-wbhk",
"metadata": {
"region": "EMEA",
"sign-up": "true"
},
"object": "customer"
},
"campaign": {
"id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"name": "Loyalty programme",
"campaign_type": "LOYALTY_PROGRAM",
"type": "AUTO_UPDATE",
"is_referral_code": false,
"voucher": {
"type": "LOYALTY_CARD",
"loyalty_card": {
"points": 0,
"expiration_rules": {
"period_type": "MONTH",
"period_value": 2,
"rounding_type": "PARTICULAR_MONTH",
"rounding_value": 1
}
},
"redemption": {
"quantity": null,
"redeemed_quantity": 0
},
"code_config": {
"pattern": "########",
"length": 8,
"charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
"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": "2024-01-18T15:18:38.577Z",
"updated_at": "2024-08-12T19:37:49.750Z",
"object": "campaign"
},
"voucher": {
"id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
"code": "MBOpskws",
"loyalty_card": {
"points": 2210,
"balance": 30,
"next_expiration_date": "2026-01-31",
"next_expiration_points": 30,
"pending_points": 1233
},
"type": "LOYALTY_CARD",
"campaign": "Loyalty programme",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"is_referral_code": false,
"holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"category_id": "cat_0e156dab8f2e43873a",
"active": true,
"created_at": "2024-01-18T15:18:39.015Z",
"updated_at": "2025-01-28T09:04:56.136Z",
"redemption": {
"quantity": null,
"redeemed_quantity": 19,
"redeemed_points": 2180
},
"start_date": null,
"expiration_date": null,
"metadata": {},
"object": "voucher"
},
"voucher_pending_points_balance": {
"points": -1,
"total": 1233,
"object": "balance",
"related_object": {
"type": "voucher",
"id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw"
},
"operation_type": "MANUAL"
},
"order": {
"id": "ord_100cc4b1b16ab710e7",
"source_id": "test_20250128-001",
"status": "PAID",
"customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"referrer_id": null,
"amount": 2499,
"total_amount": 2499,
"items": [
{
"id": "ordli_100cc5d5c20a1e29c3",
"object": "order_item",
"product_id": "prod_0f59fdfe17e465fa05",
"quantity": 1,
"amount": 500,
"price": 500,
"subtotal_amount": 500
},
{
"id": "ordli_100cc5d5c20a1e29c4",
"object": "order_item",
"product_id": "prod_0f0a6020cf2c301fdd",
"quantity": 1,
"amount": 900,
"price": 900,
"subtotal_amount": 900
},
{
"id": "ordli_100cc5d5c20a1e29c5",
"object": "order_item",
"product_id": "prod_0ef925321f691a234d",
"sku_id": "sku_0ef9253223e91a2354",
"quantity": 1,
"amount": 1099,
"price": 1099,
"subtotal_amount": 1099
}
],
"created_at": "2025-01-28T08:59:35.487Z",
"updated_at": "2025-01-28T09:04:34.578Z",
"object": "order"
},
"pending_points": {
"id": "lopp_100e0e48afc99da41a",
"voucher_id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"order_id": "ord_100cc4b1b16ab710e7",
"points": 1,
"activates_at": "2025-01-29",
"details": {
"holder_loyalty_tier": {
"id": "ltr_0e30613ad01f044517",
"name": "Loyal Star Platinum"
},
"event": {
"id": "evcus_100cc4b1b3aab710f1",
"type": "customer.order.paid",
"group_id": "v-100cc4b1ac63d4f448",
"entity_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"created_at": "2025-01-28T08:59:35.488Z",
"category": "EFFECT",
"event_source": {
"channel": "API",
"api_key": {
"name": "Primary",
"app_id": "34fdc483-066d-478b-a707-be2c7a3d3698"
}
}
},
"earning_rule": {
"id": "ern_FQxftbKUq9E93k00Z3qkC0sX",
"source": {
"banner": "Order-paid"
}
},
"order": {
"id": "ord_100cc4b1b16ab710e7",
"source_id": "test_20250128-001"
}
},
"created_at": "2025-01-28T08:59:35.814Z"
}
}