v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Verify the balance of a gift card

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.

get/v1/giftcards/{giftcard_number}/balance

Path parameters

giftcard_numberstring required

Mandatory Unique number of the guest's gift card.

Response

200

balanceinteger
user_idstring
expirystring
typestring
statusstring

Example response

{
  "balance": 9336,
  "user_id": "36fa5713-8ea2-4d66-9c22-0423344886b4",
  "expiry": "2050-10-17T00:00:00",
  "type": "AMOUNT GIFTCARD",
  "status": "Available",
  "error": {
    "code": 436,
    "message": "Gift Card Does not exist."
  }
}