Get Checkout | Clearpay Documentation

{
  "token": "002.ejh49ovam0acussgg4c6slpqqtn1ntqt3m4efqdh4qe0u8qk",
  "expires": "2023-08-29T00:57:25.754Z",
  "redirectCheckoutUrl": "https://portal.eu-sandbox.afterpay.com/uk/checkout/?token=002.ejh49ovam0acussgg4c6slpqqtn1ntqt3m4efqdh4qe0u8qk",
  "amount": {
    "amount": "100.00",
    "currency": "GBP"
  },
  "consumer": {
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "test@example.com"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "123 Fake Street",
    "area1": "",
    "region": "",
    "postcode": "AA99 9AA",
    "countryCode": "GB"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "123 Fake Street",
    "area1": "",
    "region": "",
    "postcode": "AA99 9AA",
    "countryCode": "GB"
  },
  "merchant": {
    "redirectConfirmUrl": "https://example.com/checkout/confirm",
    "redirectCancelUrl": "https://example.com/checkout/cancel",
    "popupOriginUrl": "https://example.com/cart"
  },
  "mode": "standard",
  "merchantReference": "merchant-order-123",
  "items": [
    {
      "name": "Sample Product",
      "quantity": 1,
      "price": {
        "amount": "100.00",
        "currency": "GBP"
      }
    }
  ]
}

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

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.

This endpoint retrieves an incomplete individual checkout by token. <Note title="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](/payment-object) record (Clearpay Order) along with its associated checkout details, see [Get Payment By Token](/api-reference/online-api/order-management/get-payment-by-token). </Note> <Note title="Note"> Fields that were not included in the original [Create Checkout](/api-reference/online-api/checkouts/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](/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. |

Authentication

AuthorizationBasic

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

Path parameters

tokenstringRequired

The token of the checkout to be retrieved.

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

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

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.

Connection Timeouts

Errors

Authentication

Path parameters

Headers

Response

Errors

Connection Timeouts

Errors