Get Checkout

This endpoint retrieves an incomplete individual checkout by token.

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. </Note>

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Errors

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

HTTP Status Code	errorCode	Description
404 <br />Not Found	not_found	No checkout token was provided.
412 <br />Precondition Failed	invalid_token	The checkout token is invalid, expired, completed, or does not exist.

get/v2/checkouts/{token}

Request

Base URL: https://global-api-sandbox.afterpay.com
URL: https://global-api-sandbox.afterpay.com/v2/checkouts/{token}
Auth: HTTP basic

Path parameters

tokenstring required

The token of the checkout to be retrieved.

Headers

User-Agentstring required

Acceptstring

Response

Get Checkout Response

tokenstring required

Checkout token to be used to complete payment.

expiresstring required

The UTC timestamp of when the checkout token will expire, in ISO 8601 format.

redirectCheckoutUrlstring required

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.

descriptionstring

A description of the order.

mode'express' | 'standard'

Must be set to express to enable express checkout.

merchantReferencestring

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

Changes

No recorded changes to this operation across all 1 revision of this API.