Skip to navigation
Online APICheckouts

Get Checkout

This endpoint retrieves an incomplete individual checkout by token.

Note

Checkout details are only retained in this temporary format for up to 60 minutes. If a checkout token expires or has an order created against it, it can no longer be retrieved from this endpoint.

To retrieve a Payment record (Clearpay Order) along with its associated checkout details, see Get Payment By Token.

Note

Fields that were not included in the original Create Checkout request may not be included in any corresponding Get Checkout response.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

In addition to the GET Errors applicable to all GET endpoints, the following errors are specific to Get Checkout:

HTTP Status CodeerrorCodeDescription
404
Not Found		not_foundNo checkout token was provided.
412
Precondition Failed		invalid_tokenThe checkout token is invalid, expired, completed, or does not exist.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

tokenstringRequired
The token of the checkout to be retrieved.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Response

Get Checkout Response
tokenstring
Checkout token to be used to complete payment.
expiresstring
The UTC timestamp of when the checkout token will expire, in ISO 8601 format.
redirectCheckoutUrlstring
A URL that can be used to redirect the consumer to the Clearpay screenflow directly from the merchant backend. This can be used as an alternative to implementing the JavaScript afterpay.js.
amountobjectOptional
Total amount to be charged to consumer.
consumerobjectOptional
The consumer requesting the order.
billingobjectOptional
Billing address.
shippingobjectOptional
Shipping address.
courierobjectOptional
Shipping courier details.
descriptionstringOptional
A description of the order.
merchantobjectOptional
Merchant configuration details.
modeenumOptional

Must be set to express to enable express checkout.

Allowed values:
merchantReferencestringOptional

The merchant’s id/reference that this order corresponds to.

itemslist of objectsOptional
An array of order items.
discountslist of objectsOptional
An array of discounts.
shippingAmountobjectOptional
The shipping amount.
taxAmountobjectOptional
The included tax amount after applying all discounts.
shippingOptionsobjectOptional
Shipping option details.

Errors

404
Not Found Error
412
Precondition Failed Error