Skip to main content
WEBHOOK
EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ACTIVATED
{
  "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": 46
    },
    "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:08:34.127Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 0,
      "redeemed_points": 0
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "balance": {
    "points": 23,
    "total": 23,
    "balance": 23,
    "type": "loyalty_card",
    "object": "balance",
    "related_object": {
      "type": "voucher",
      "id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v"
    },
    "operation_type": "MANUAL"
  },
  "order": {
    "id": "ord_0ff203bb8a0ca13337",
    "source_id": null,
    "status": "PAID",
    "customer_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "referrer_id": null,
    "amount": 500,
    "total_amount": 500,
    "items": [
      {
        "id": "ordli_0ff203bb898ca13335",
        "object": "order_item",
        "product_id": "prod_0fc35dfeabcdefeb80",
        "quantity": 1,
        "amount": 500,
        "price": 500,
        "subtotal_amount": 500
      },
      {
        "id": "ordli_0ff203bb898ca13336",
        "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-07T14:16:01.311Z",
    "object": "order"
  },
  "transaction": {
    "id": "vtx_0ff34b9df109a39357",
    "source_id": null,
    "voucher_id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
    "campaign_id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
    "source": null,
    "reason": null,
    "type": "PENDING_POINTS_ACTIVATION",
    "details": {
      "balance": {
        "type": "loyalty_card",
        "total": 23,
        "object": "balance",
        "points": 23,
        "balance": 23,
        "operation_type": "MANUAL",
        "related_object": {
          "id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
          "type": "voucher"
        }
      },
      "order": {
        "id": "ord_0ff203bb8a0ca13337",
        "source_id": null
      },
      "event": {
        "id": "evcus_0ff203bb8d4ca13341",
        "type": "customer.order.paid"
      },
      "earning_rule": {
        "id": "ern_vjzc7A2IHoCUbl5lyO6kyJQM",
        "source": {
          "banner": "Here come your loyalty points"
        }
      },
      "pending_points": {
        "id": "lopp_0ffd9a0a87c8dd17c9",
        "points": 23,
        "details": {
          "event": {
            "id": "evcus_0ff203bb8d4ca13341",
            "type": "customer.order.paid",
            "category": "EFFECT",
            "group_id": "v-0ff203bb84d36fe41a",
            "entity_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
            "created_at": "2025-01-07T14:16:01.312Z",
            "event_source": {
              "user": {
                "id": "user_ypzfEcSAphSONMGJRlj6trzXKsh7FGX7"
              },
              "channel": "USER_PORTAL"
            }
          },
          "order": {
            "id": "ord_0ff203bb8a0ca13337",
            "source_id": null
          },
          "earning_rule": {
            "id": "ern_vjzc7A2IHoCUbl5lyO6kyJQM",
            "source": {
              "banner": "Here come your loyalty points"
            }
          }
        },
        "order_id": "ord_0ff203bb8a0ca13337",
        "created_at": "2025-01-07T14:16:02.296Z",
        "voucher_id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
        "campaign_id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
        "customer_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
        "activates_at": "2025-01-16"
      }
    },
    "related_transaction_id": null,
    "created_at": "2025-01-08T14:08:34.127Z"
  },
  "pending_points": {
    "id": "lopp_0ffd9a0a87c8dd17c9",
    "voucher_id": "v_bITntTcyfRHPvrOMgwdQVSlShsWRZu4v",
    "campaign_id": "camp_E14SFSXh2JueXgZ0wFarf3jU",
    "customer_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
    "order_id": "ord_0ff203bb8a0ca13337",
    "points": 23,
    "activates_at": "2025-01-16",
    "details": {
      "event": {
        "id": "evcus_0ff203bb8d4ca13341",
        "type": "customer.order.paid",
        "group_id": "v-0ff203bb84d36fe41a",
        "entity_id": "cust_KiZa6C6R30sgqqpU76o6B7u0",
        "created_at": "2025-01-07T14:16:01.312Z",
        "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_0ff203bb8a0ca13337",
        "source_id": null
      }
    },
    "created_at": "2025-01-07T14:16:02.296Z"
  }
}
The EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ACTIVATED event indicates that loyalty pending points have been successfully activated and added to a customer’s loyalty card associated with a voucher. The pending points can be activated automatically after a predefined time set in days or manually with the POST Activate Member Pending Points endpoint. This event is used in a webhook configured in Project settings 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 voucher.loyalty_card.pending_points.activated.

​
customer
object
required

Simplified customer data.

​
campaign
object
required

Simplified campaign data.

​
voucher
object
required

Simplified voucher data.

​
balance
object
required

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

​
order
object
required

Order information.

​
transaction
object
required

Transaction details of the voucher.

​
pending_points
object
required

Contains details about the pending point entry.

Response

Webhook accepted

⌘I