Voucher Gift Balance Added

WEBHOOK EVENTS.CUSTOMER.VOUCHER.GIFT.BALANCE_ADDED

customer.voucher.gift.balance_added

{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "campaign": {
    "id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
    "name": "Gift programme",
    "campaign_type": "GIFT_VOUCHERS",
    "type": "AUTO_UPDATE",
    "is_referral_code": false,
    "voucher": {
      "type": "GIFT_VOUCHER",
      "gift": {
        "amount": 5000,
        "effect": "APPLY_TO_ORDER"
      },
      "redemption": {
        "quantity": null,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 1,
        "prefix": "Gift-for-you-",
        "charset": "0123456789",
        "pattern": "#",
        "postfix": ""
      }
    },
    "auto_join": false,
    "join_once": false,
    "active": true,
    "category_id": "cat_0e1d0ba99c2fff2b51",
    "category": null,
    "metadata": {},
    "start_date": null,
    "expiration_date": null,
    "description": null,
    "created_at": "2024-01-24T12:07:35.835Z",
    "updated_at": "2024-02-07T11:17:53.712Z",
    "object": "campaign"
  },
  "voucher": {
    "id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
    "code": "Gift-for-you-0",
    "gift": {
      "amount": 16600,
      "balance": 15900,
      "effect": "APPLY_TO_ORDER"
    },
    "type": "GIFT_VOUCHER",
    "campaign": "Gift programme",
    "campaign_id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
    "is_referral_code": false,
    "holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "category_id": "cat_0e1d0ba99c2fff2b51",
    "active": true,
    "created_at": "2024-01-24T12:07:36.501Z",
    "updated_at": "2024-03-13T16:54:14.688Z",
    "redemption": {
      "quantity": null,
      "redeemed_quantity": 1,
      "redeemed_amount": 700
    },
    "start_date": null,
    "expiration_date": null,
    "metadata": {},
    "object": "voucher"
  },
  "balance": {
    "type": "gift_voucher",
    "total": 16600,
    "amount": 400,
    "object": "balance",
    "balance": 15900,
    "related_object": {
      "id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
      "type": "voucher"
    }
  },
  "transaction": {
    "id": "vtx_0e6feafe6952a94a54",
    "source_id": null,
    "voucher_id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
    "campaign_id": "camp_bfrwAVsP6Q1EM1ZjgHwheKYr",
    "source": "voucherify-web-ui",
    "reason": "Refund",
    "type": "CREDITS_ADDITION",
    "details": {
      "balance": {
        "type": "gift_voucher",
        "total": 16600,
        "amount": 400,
        "object": "balance",
        "balance": 15900,
        "operation_type": "MANUAL",
        "related_object": {
          "id": "v_oNia4nTFDqYZOWYJiMpX8ocB6p6ZaEBm",
          "type": "voucher"
        }
      }
    },
    "related_transaction_id": null,
    "created_at": "2024-03-13T16:54:14.688Z"
  }
}

The EVENTS.CUSTOMER.VOUCHER.GIFT.BALANCE_ADDED event indicates that additional balance has been successfully added to a customer’s 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 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.gift.balance_added.

customer · Simple Customer · object

Simplified customer data.

Show child attributes

campaign · Simple Campaign · object

Simplified campaign data.

Show child attributes

voucher · Simple Voucher · object

Simplified voucher data.

Show child attributes

balance · Voucher Balance Data · object

Voucher balance data for gift vouchers

Show child attributes

transaction · Voucher Transaction · object

Transaction details of the voucher.

Show child attributes

Response

200

Webhook accepted