Response body schema for vouchers/{code}/balance.
Name | Type | Description | Notes |
---|---|---|---|
amount | Integer | The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift card or loyalty card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | |
total | Integer | Total income incurred over the lifespan of the gift card or loyalty card. | |
balance | Integer | The balance after adding or subtracting a specified amount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | |
type | TypeEnum | The type of voucher being modified. | |
operationType | OperationTypeEnum | ||
_object | ObjectEnum | The type of the object represented by JSON. Default is `balance`. | |
relatedObject | VouchersBalanceUpdateResponseBodyRelatedObject |
Name | Value |
---|---|
GIFT_VOUCHER | "gift_voucher" |
LOYALTY_CARD | "loyalty_card" |
Name | Value |
---|---|
MANUAL | "MANUAL" |
Name | Value |
---|---|
BALANCE | "balance" |