Voucher register spend voucher - Heyloyalty/api GitHub Wiki

Using this endpoint, you can register vouchers used by customers either online or from our Point of Sale (PoS/cash register).

The endpoint is available from your Heyloyalty account and can be seen for every group of voucherpools. Using the endpoint requires standard authorization for your account.

Otherwise all you need is to add the voucher used by the customer, at the end:

image

Note: when fetching your endpoint {groupID} will be an integer for your vouchergroup. {voucher} should be the value for the voucher

If the voucher used is "ABC123" you add this to the endpoint, found within your voucher integration

Example

In the given example {groupdID} is 42 and the voucher sent to the customer is ABC123

Make a POST call to endpoint:

POST https://api.heyloyalty.com/loyalty/v1/voucher/42/ABC123

IF you recieve an error

If you recieve "voucher not found", it is because of the following:

  • Voucher doesn't exist
  • If the voucher isn't reserved to a member
  • If the voucher doesn't have a member_ID attached to it
  • if it has been registered as "used"