Voucher Loyalty Card Pending Points Updated

WEBHOOK EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.UPDATED

customer.voucher.loyalty_card.pending_points.updated

{
  "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": "L0y4L",
    "loyalty_card": {
      "points": 28786,
      "balance": 5156,
      "next_expiration_date": "2026-01-31",
      "next_expiration_points": 23786,
      "pending_points": 41,
      "subtracted_points": 4000
    },
    "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-03-06T11:39:53.395Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 262,
      "redeemed_points": 19630
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "voucher_pending_points_balance": {
    "points": 10,
    "total": 41,
    "object": "balance",
    "related_object": {
      "type": "voucher",
      "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw"
    },
    "operation_type": "MANUAL"
  },
  "order": {
    "id": "ord_103c8af3c09ea311b4",
    "source_id": null,
    "status": "PAID",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "referrer_id": null,
    "amount": 36500,
    "discount_amount": 50,
    "total_discount_amount": 50,
    "total_amount": 36450,
    "items": [
      {
        "id": "ordli_103c8af3c09ea311b5",
        "object": "order_item",
        "source_id": "adv-scks",
        "related_object": "product",
        "quantity": 1,
        "amount": 1500,
        "price": 1500,
        "subtotal_amount": 1500
      },
      {
        "id": "ordli_103c8af3c09ea311b6",
        "object": "order_item",
        "source_id": "adv-tshirt",
        "related_object": "product",
        "quantity": 2,
        "amount": 5000,
        "price": 2500,
        "subtotal_amount": 5000
      },
      {
        "id": "ordli_103c8af3c09ea311b7",
        "object": "order_item",
        "source_id": "adv-poster",
        "related_object": "product",
        "quantity": 10,
        "amount": 25000,
        "price": 2500,
        "subtotal_amount": 25000
      },
      {
        "id": "ordli_103c8af3c09ea311b8",
        "object": "order_item",
        "source_id": "adv-poster",
        "related_object": "product",
        "quantity": 1,
        "amount": 2500,
        "price": 2500,
        "subtotal_amount": 2500
      },
      {
        "id": "ordli_103c8af3c09ea311b9",
        "object": "order_item",
        "source_id": "adv-poster",
        "related_object": "product",
        "quantity": 1,
        "amount": 2500,
        "price": 2500,
        "subtotal_amount": 2500
      }
    ],
    "metadata": {},
    "created_at": "2025-03-06T11:34:24.301Z",
    "updated_at": "2025-03-06T11:34:24.366Z",
    "object": "order"
  },
  "pending_points": {
    "id": "lopp_103dd48adba7591619",
    "voucher_id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
    "campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "order_id": "ord_103c8af3c09ea311b4",
    "points": 35,
    "activates_at": "2025-03-07",
    "details": {
      "holder_loyalty_tier": {
        "id": "ltr_0e30613ad01f044517",
        "name": "Loyal Star Platinum"
      },
      "event": {
        "id": "evcus_103c8af3cedea311c3",
        "type": "customer.order.paid",
        "group_id": "v-103c8af396ae968360",
        "entity_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
        "created_at": "2025-03-06T11:34:24.302Z",
        "category": "EFFECT",
        "event_source": {
          "channel": "API",
          "api_key": {
            "name": "Primary",
            "app_id": "12abc345-678d-901e-f234-gh5i6j7k8901"
          }
        }
      },
      "earning_rule": {
        "id": "ern_F8RCTaDdMTUo0pOBQBBHr5el",
        "source": {
          "banner": "Earn points and wait"
        }
      },
      "order": {
        "id": "ord_103c8af3c09ea311b4",
        "source_id": null
      }
    },
    "created_at": "2025-03-06T11:34:24.483Z",
    "updated_at": "2025-03-06T11:39:53.395Z"
  }
}

The EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.UPDATED event indicates that loyalty pending points have been updated on a customer’s loyalty card associated with a voucher. The pending points can be updated by adding or subtracting points.

This event is used in a webhook configured in Distributions in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.voucher.loyalty_card.pending_points.updated.

customer · Simple Customer · object · required

Simplified customer data.

Show child attributes

campaign · Simple Campaign · object · required

Simplified campaign data.

Show child attributes

voucher · Simple Voucher · object · required

Simplified voucher data.

Show child attributes

voucher_pending_points_balance · Voucher Balance · object · required

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

Show child attributes

order · Simple Order · object · required

Order information.

Show child attributes

pending_points · Loyalty Pending Point Entry · object · required

Contains details about the pending point entry.

Show child attributes

Response

200

Webhook accepted