Skip to main content

Fields

availableFrom : Date

When the voucher becomes available to be redeemed.

balance : Int

The current balance left in the voucher.

The amount charged for the voucher.

chargeBalanceTransfer : AccountBalanceTransferType

A balance transfer for the voucher charge, if any.

clientParams : JSONString

Additional metadata from client sources stored against the voucher. This data is not structural and won't be relied on by Kraken internally.

displayName : String

Display name for the voucher purchase.

id : ID

The purchase ID.

payment : AccountPaymentType

The payment associated with the voucher purchase, if any.

purchasedAt : DateTime

When the purchase was performed.

redemptions : [VoucherRedemptionType]

Fetch the redemptions for this voucher.

refundedAt : DateTime

When the voucher was refunded, if it was refunded.

voucherValue : Int

The value of the voucher in cents.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "availableFrom": "2004-11-28", "balance": 54, "charge": AccountChargeType, "chargeBalanceTransfer": AccountBalanceTransferType, "clientParams": {"key": "value"}, "displayName": "heavy-family-staff-kid-recognize", "id": "95219014", "payment": AccountPaymentType, "purchasedAt": "2004-06-30T05:41:03.249566+00:00", "redemptions": [VoucherRedemptionType], "refundedAt": "1978-03-03T16:37:27.513059+00:00", "voucherValue": 44 }