Checkout

Attributes

Parameter	Type	Description
id	string	The unique identifier for the checkout.
paymentId	string	The unique identifier for the payment.
redirectUrl	string	The URL to redirect customers to in order to complete the checkout.
status	enum	The status of the checkout, one of created, started, processing, completed or refunded.
amount	integer	The final amount you would like to charge the customer, in cents. Including all the discounts and applicable taxes.
currency	string	The 3-letter currency code in ISO 4217 format. Currently we only support ZAR.
successUrl	string	The URL to optionally redirect customers to when the checkout completes successfully.
cancelUrl	string	The URL to redirect customers to when the checkout is cancelled.
failureUrl	string	The URL to optionally redirect customers to when the checkout does not complete successfully.
metadata	map	Used to record additional details about the checkout, often used to reconcile data with an external system.
merchantId	string	Reference used internally to identify the merchant.
totalDiscount	integer	The total discount, in cents, is used for display only. It must already be included in the amount to collect.
totalTaxAmount	integer	The total tax, in cents, is used for display only. It must already be included in the amount to collect.
subtotalAmount	integer	The subtotal, in cents, is used for display only and represents the total value collected including taxes and excluding discounts.
lineItems	list	The line items are used for display only and provide additional details for the items purchased during checkout.
processingMode	string	The mode of the checkout, as determined from the key used to create the checkout. One of either live or test.