Input fields

accountNumber : ID! required

The account to purchase a voucher for.
availableFrom : Date! required

When the voucher becomes available to be redeemed.
chargeAmountInCents : Int

How much to charge the account for in cents. Excludes tax.
chargeAmountInCentsWithTax : Int

How much to charge the account for in cents. Includes tax.
clientParams : JSONString default: {}

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

Display name for the voucher purchase. Maximum length is 255 characters.
paymentId : ID

The ID of the payment, if any.
purchasedAt : DateTime! required

When the purchase was performed.
transferChargeLedgerNumber : ID

The ledger number of the ledger to transfer the charge to, if any.
voucherType : String! required

The type of voucher.
voucherValueInCents : Int! required

How much to credit the account for this 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

{ "accountNumber": "A-5E10A0D7", "availableFrom": "2002-10-25", "chargeAmountInCents": 99, "chargeAmountInCentsWithTax": 14, "clientParams": {"key": "value"}, "displayName": "fly-image-herself-yard-challenge", "paymentId": "26779531", "purchasedAt": "1989-04-16T04:05:07.169974+00:00", "transferChargeLedgerNumber": "92568871", "voucherType": "onto-unit-baby-nearly-not", "voucherValueInCents": 35 }