This endpoint creates a checkout used to start the Clearpay payment process. Clearpay uses the information in the order request to assist with the customer’s pre-approval process.
Warning
The Readme API Simulator includes form elements for both required and optional Body Params. If not populated with values, Readme will send empty strings to the Clearpay Online API. Any optional parameter that is validated against a Model will need to have all of its required sub-params populated with non-empty values.
Therefore, to avoid receiving unexpected "400" responses from Clearpay, please fill out all fields of the simulation form with valid values. This is particularly important for the
amountandcurrencysub-params of theamount,taxAmountandshippingAmountparams.
Note
The
popupOriginUrlis optional if using theredirectConfirmURLand is found under themerchantobject. However, this method is used by most new merchants. You can see how the method is used for Express Checkout and read more about the Popup method under our Standard Checkout page.
Successful Response (201)
Returns a token, expiry date/time and checkout URL if successful.
| 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. |
Note
It is not possible to update the checkout information (including
amount) after the token is generated.If the consumer's cart changes on the merchant side after a token is generated, please discard this token. Use the current checkout information to generate a new checkout token. Use the new token to send the consumer through the Clearpay screenflow before attempting to call Auth or Capture Full Payment.
Connection Timeouts
| Timeout | Time (Seconds) |
|---|---|
| Open | 10 |
| Read | 20 |
Errors
In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Create Checkout:
| HTTP Status Code | errorCode | Description |
|---|---|---|
| 422 Unprocessable Entity | invalid_object | One or more required fields were missing or invalid. |
| 422 Unprocessable Entity | unsupported_payment_type | The amount is outside of the merchant's payment limits, as returned by Get Configuration. |
| 422 Unprocessable Entity | unsupported_currency | One or more Money objects may have contained a currency that differs from the merchant's account currency. |