post https://example.com/EVENTS.VOUCHER.GIFT.TRANSACTION.CREATED
EVENT: "EVENTS.VOUCHER.GIFT.TRANSACTION.CREATED"
HTTP method: POST
HTTP method: POST
The EVENTS.VOUCHER.GIFT.TRANSACTION.CREATED event indicates that a transaction has been created for a gift voucher. It provides real-time notification that the gift voucher's balance has been increased.
The following transaction types trigger the event:
CREDITS_ADDITIONCREDITS_REMOVALCREDITS_REFUNDCREDITS_REDEMPTION
This event is used in a webhook configured in Project settings in Voucherify dashboard.
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: voucher.gift.transaction.created
{
"transaction": {
"id": "vtx_0f1c4589b8cd1c07b2",
"source_id": null,
"voucher_id": "v_Wi8kP8EW4f1L2yT2N7tfFXxMzZOp7EsS",
"campaign_id": "camp_gYFHS8RZw9seypbbBPXmRboq",
"source": "voucherify-web-ui",
"reason": null,
"type": "CREDITS_ADDITION",
"details": {
"balance": {
"type": "gift_voucher",
"total": 2000,
"amount": 1000,
"object": "balance",
"balance": 2000,
"operation_type": "MANUAL",
"related_object": {
"id": "v_Wi8kP8EW4f1L2yT2N7tfFXxMzZOp7EsS",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2024-07-25T13:48:34.908Z"
},
"voucher": {
"id": "v_Wi8kP8EW4f1L2yT2N7tfFXxMzZOp7EsS",
"code": "3HgJNUlD",
"campaign": "test gift 1807",
"campaign_id": "camp_gYFHS8RZw9seypbbBPXmRboq",
"category": null,
"category_id": null,
"categories": [],
"type": "GIFT_VOUCHER",
"discount": null,
"gift": {
"amount": 2000,
"balance": 2000,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_hours": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "8d3ddf23-a85b-477d-aa11-d1c2c917f632",
"url": "{{voucher_qr_code.url}}"
},
"barcode": {
"id": "c47dc508-6ca8-4697-bf1d-e9d2082b6c53",
"url": "{{voucher_barcode.url}}"
}
},
"is_referral_code": false,
"created_at": "2024-07-23T10:01:01.848Z",
"updated_at": "2024-07-25T13:48:34.908Z",
"holder_id": "cust_PL4iqfS8K5Ej2LuBNV1RqlfJ",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"redeemed_amount": 0,
"object": "list",
"url": "/v1/vouchers/3HgJNUlD/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/3HgJNUlD/publications?page=1&limit=10"
},
"object": "voucher"
},
"campaign": {
"id": "camp_gYFHS8RZw9seypbbBPXmRboq",
"name": "test gift 1807",
"campaign_type": "GIFT_VOUCHERS",
"type": "AUTO_UPDATE",
"is_referral_code": false,
"voucher": {
"type": "GIFT_VOUCHER",
"discount": null,
"gift": {
"amount": 0,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": null,
"redemption": {
"quantity": null,
"redeemed_quantity": 0
},
"code_config": {
"pattern": "########",
"length": 8,
"charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
"prefix": "",
"postfix": ""
}
},
"auto_join": false,
"join_once": false,
"active": true,
"category_id": null,
"category": null,
"metadata": {},
"start_date": null,
"expiration_date": null,
"description": null,
"created_at": "2024-07-18T13:22:42.429Z",
"object": "campaign"
},
"holder": {
"id": "cust_PL4iqfS8K5Ej2LuBNV1RqlfJ",
"name": "John Demo 23-01",
"email": null,
"source_id": "230724-01",
"metadata": {},
"object": "customer"
},
"balance": {
"amount": 1000,
"total": 2000,
"balance": 2000,
"type": "gift_voucher",
"object": "balance",
"related_object": {
"type": "voucher",
"id": "v_Wi8kP8EW4f1L2yT2N7tfFXxMzZOp7EsS"
},
"operation_type": "MANUAL"
},
"order": null,
"redemption": null,
"rollback": null
}