45 lines (25 loc) · 1.53 KB

VouchersBalanceUpdateResponseBody

Response body schema for vouchers/{code}/balance.

Properties

Name	Type	Description
amount	Integer	The incremental amount added (positive integer) or subtracted (negative integer) to the current balance on the gift card or loyalty card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
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. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
type	TypeEnum	The type of voucher being modified.
operationType	OperationTypeEnum	The type of the operation being performed.
_object	ObjectEnum	The type of the object represented by JSON. Default is `balance`.
relatedObject	VouchersBalanceUpdateResponseBodyRelatedObject

Enum: TypeEnum

Name	Value
GIFT_VOUCHER	"gift_voucher"
LOYALTY_CARD	"loyalty_card"

Enum: OperationTypeEnum

Name	Value
MANUAL	"MANUAL"

Enum: ObjectEnum

Name	Value
BALANCE	"balance"