Skip to navigation
Online APIHow to Integrate

Create Checkout [Express Checkout]

This endpoint creates a checkout that is used to initiate the Clearpay payment process. Clearpay uses the information in the order request to assist with the consumer’s pre-approval process.

Successful Response (201)

Returns a token, expiry date/time and checkout URL if successful.

AttributeTypeDescription
tokenstringCheckout token to be used to complete payment.
expiresstringThe UTC timestamp of when the checkout token will expire, in ISO 8601 format.
redirectCheckoutUrlstringA 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.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Create Checkout:

HTTP Status CodeerrorCodeDescription
422
Unprocessable Entity		invalid_objectOne or more required fields were missing or invalid.
422
Unprocessable Entity		unsupported_payment_typeThe amount is outside of the merchant’s payment limits, as returned by Get Configuration.
422
Unprocessable Entity		unsupported_currencyOne or more Money objects may have contained a currency that differs from the merchant’s account currency.

Authentication

AuthorizationBasic

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

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Request

This endpoint expects an object.
amountobjectRequired
Total amount for order to be charged to consumer.
modeenumRequiredDefaults to express

Must be set to express to enable express checkout.

Allowed values:
merchantobjectRequired

Response

200
tokenstringOptional
expiresstringOptional
redirectCheckoutUrlstringOptional

Errors

400
Bad Request Error