Skip to main content
WEBHOOK
EVENTS.VOUCHER.GIFT.BALANCE_ADDED
{
  "balance": {
    "type": "gift_voucher",
    "total": 16200,
    "amount": 1200,
    "object": "balance",
    "balance": 11500,
    "operation_type": "MANUAL",
    "related_object": {
      "id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
      "type": "voucher"
    }
  },
  "voucher": {
    "id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
    "code": "Gift-for-you-0",
    "gift": {
      "amount": 16200,
      "effect": "APPLY_TO_ORDER",
      "balance": 11500
    },
    "type": "GIFT_VOUCHER",
    "active": true,
    "object": "voucher",
    "campaign": "Gift programme",
    "metadata": {},
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "created_at": "2024-01-24T12:07:36.501Z",
    "redemption": {
      "quantity": null,
      "redeemed_amount": 4700,
      "redeemed_quantity": 2
    },
    "updated_at": "2024-02-09T13:27:46.844Z",
    "campaign_id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
    "category_id": "cat_0e1d0ba99c2fff2b51",
    "is_referral_code": false
  },
  "campaign": {
    "id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
    "name": "Gift programme",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": {
        "amount": 5000,
        "effect": "APPLY_TO_ORDER"
      },
      "type": "GIFT_VOUCHER",
      "discount": null,
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 1,
        "prefix": "Gift-for-you-",
        "charset": "0123456789",
        "pattern": "#",
        "postfix": ""
      },
      "loyalty_card": null
    },
    "metadata": {},
    "auto_join": false,
    "join_once": false,
    "created_at": "2024-01-24T12:07:35.835Z",
    "updated_at": "2024-02-07T11:17:53.712Z",
    "category_id": "cat_0e1d0ba99c2fff2b51",
    "campaign_type": "GIFT_VOUCHERS",
    "is_referral_code": false
  },
  "transaction": {
    "id": "vtx_0e453f45e82ef51f2a",
    "type": "CREDITS_ADDITION",
    "details": null,
    "created_at": "2024-02-09T13:27:46.844Z",
    "campaign_id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr"
  }
}
The EVENTS.VOUCHER.GIFT.BALANCE_ADDED event indicates that additional balance has been successfully added to a gift voucher. It provides real-time notification that the gift voucher’s balance has been increased. 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
voucher
object
balance
object
campaign
object
transaction
object

Response