Get Voucher Balance

This is a simple request to check the balance based on the voucherCode supplied. This request is in the form of HTTP POST to the url:

GET https://shop.bookin1.com/redeem/api/balance/{voucherCode}

curl -X GET \
  https://shop.bookin1.com/redeem/api/balance/1001-1234-56XX-XXXX \
  -H 'Content-Type: application/json' \
  -H 'apiKey: 4eC39HqLyjWDarjtT1zdp7dc'

If successful, we will return the following object.

{
  "balanceAmount": 0,
  "currency": "string",
  "transactionId": "string",
  "voucherCode": "string",
  "voucherDescription": "string",
  "voucherExpiryDate": "2020-01-13T11:43:21.876Z",
  "voucherName": "string",
  "voucherPropertyName": "string",
  "voucherStartDate": "2020-01-13T11:43:21.876Z"
}

Request Balance Response Object

Name	Type	Description
balanceAmount	double	Value of current gift voucher balance after the redeem action is done
currency	string	Currency string in ISO 4217 format.
transactionId	string	If provided in the request, it is outputed in the response otherwise it's auto generated via the api.
voucherCode	string	Gift voucher code used for redeem
voucherDescription	string	Descriptive text of the actual gift voucher purchased.
voucherExpiryDate	date	Gift voucher expiry date.
voucherName	string	Name of the gift voucher.
voucherPropertyName	string	Property responsible for issuing the gift voucher
voucherStartDate	date	Date from which the gift voucher is active. This is usually the purchase date, but can also be delayed start date.