get https://global-api-sandbox.afterpay.com/v2/checkouts/
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.
Successful Response (200)
If a checkout belonging to the authenticated merchant account is found, returns the checkout details in response. Fields that were not included in the original Create Checkout request may not be included in any corresponding Get Checkout response.
| Attribute | Type | Description |
|---|---|---|
token | string | Checkout token to be used to complete payment. |
expires | string | The UTC timestamp of when the checkout token will expire, in ISO 8601 format. |
redirectCheckoutUrl | string | 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. |
amount | Money | Total amount to be charged to consumer. |
consumer | Consumer | The consumer requesting the order. |
billing | Contact | Billing address. |
shipping | Contact | Shipping address. |
courier | Shipping Courier | Shipping courier details. |
description | string | A description of the order. |
merchant.redirectConfirmUrl | string | The consumer is redirected to this URL on confirmation. |
merchant.redirectCancelUrl | string | The consumer to redirected to this URL if the payment process is cancelled. |
merchantReference | string | The merchant's id/reference that this order corresponds to. |
items | Item[] | An array of order items. |
discounts | Discount[] | An array of discounts. |
shippingAmount | Money | The shipping amount. |
taxAmount | Money | The included tax amount after applying all discounts. |
shippingOptions | string | Shipping option details. |
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 Not Found | not_found | No checkout token was provided. |
| 412 Precondition Failed | invalid_token | The checkout token is invalid, expired, completed, or does not exist. |