For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
- Merchant calls the Get Configuration endpoint to retrieve Clearpay order limits, possibly as part of an asynchronous scheduled background process.
- Merchant stores these minimum and maximum order values server-side.
- Separately, at the checkout, Merchant uses the stored Clearpay minimum and maximum order values to determine if Clearpay should be presented as an available payment method.
- Merchant calls the Create Order endpoint to retrieve a Clearpay order token.
- Merchant uses the token in combination with the JavaScript afterpay.js to direct the Consumer through the Clearpay screenflow.
- Consumer completes the Clearpay screenflow and is returned to the Merchant website.
- If the Consumer clicks “confirm”, they will be returned to the Merchant website with the
orderToken and a status of “SUCCESS”.
- If the Consumer cancels, they will be returned to the Merchant website with the
orderToken and a status of “CANCELLED”.
- If the merchant is able to fulfil the order, the merchant calls the Capture Payment endpoint to capture the payment.
- Payment status (“APPROVED” or “DECLINED”) is only known once Capture Payment has been completed.
- If the payment was approved by Clearpay, the Merchant presents the Consumer with an order confirmation/receipt page.
- If the payment was declined by Clearpay (e.g. the Consumer’s card details are entered incorrectly), the Merchant presents an appropriate message to the Consumer at the checkout.