Voucher Payment | NaviPartner | NP Retail API Documentation

Event voucher_payment. Triggered when voucher is used for payment. Your endpoint will receive this POST request.

The payload of this webhook request is an object.

appIdUUIDRequired

clientStatestringRequired

companyIdUUIDRequired

companyNamestringRequired

eventNamestringRequired

eventVersionstringRequired

initiatingUserAADObjectIdstringRequired

payloadobjectRequired

timestampdatetimeRequired

200

any

Return a 200 status to indicate that the data was received successfully.

1	{
2	"appId": "992c2309-cca4-43cb-9e41-911f482ec088",
3	"clientState": "secret_value_from_subscription_creation_mirrored",
4	"companyId": "b56a418d-8205-4d3a-bdbb-25d94e42abbd",
5	"companyName": "CRONUS International Ltd.",
6	"eventName": "voucher_created",
7	"eventVersion": "1.0",
8	"initiatingUserAADObjectId": "ef546153-4168-4bd5-9365-a3161608da72",
9	"payload": {
10	"voucherId": "e20d09ad-ab74-4f31-912f-ea58d3c9e653",
11	"voucherType": "GIFTVOUCHER",
12	"initialamount": 1000,
13	"amount": 1000,
14	"customerNo": "C12345678"
15	},
16	"timestamp": "2024-06-28T12:00:00Z"
17	}