get https://api.zenoti.com/v1/giftcards//balance
This API helps you to verify the balance of a guest's Zenoti gift card.
If the guest's gift card contains sufficient balance, you can redeem the gift card to collect payment for an invoice.
You must specify appropriate data for the giftcard_number parameter.
Response Details
| Name | Type | Description |
|---|---|---|
| balance | decimal | Indicates the balance of the guest's gift card. |
| user_id | guid | Unique 32-character identifier of the guest. |
| expiry | datetime | Expiry date details of the guest's gift card. |
| type | string | Type of the guest's specified gift card. |
| status | string | Indicates whether the gift card is available to be redeemed. |
| error | object | Object that contains error message and error code details. For more information, refer to the error table below. |
error
| Name | Type | Description |
|---|---|---|
| code | int | Status code that represents the type of the error. |
| message | string | Message that describes the error. |
Error Message Details
| Error Message | Error Code | Description |
|---|---|---|
| invalid giftcard_number. | 436 | If the guest's gift card number is not valid. |
| Gift Card Does not exist. | 436 | If the guest's gift card details could not be retrieved. |
| user cannot access. | 502 | If you do not have the required permissions to verify the guest's gift card balance. |
| unable to check giftcard balance. | 492 | If the guest's gift card balance could not be verified. |