This flow completes the payment approval, starts the consumer's payment plan, and settles the full order value with the merchant - all as a combined action.

  1. Merchant calls the Get Configuration endpoint to retrieve Clearpay order limits, possibly as part of an asynchronous scheduled background process.

  2. Merchant stores these minimum and maximum order values server-side.

  3. Separately, at the checkout, the Merchant uses the stored Clearpay minimum and maximum order values to determine if Clearpay should be presented as an available payment method.

  4. Merchant calls the Create Checkout endpoint to retrieve a Clearpay order token.
    4.1 Optional Merchant uses the token in combination with the JavaScript clearpay.js to direct the Consumer through the Clearpay checkout.

  5. The consumer completes the Clearpay screen flow and is returned to the Merchant website.

    • If the Consumer gets approved by our risk engine, and we are able to successfully charge them, they will be returned to the Merchant website with the orderToken and a status of "SUCCESS".
    • If the Consumer gets approved by our risk engine, but we are not able to successfully charge them, they get redirected to the Merchant website with the orderToken and a status of "CANCELLED"
    • If the Consumer gets rejected by our risk engine, they will not reach the payment screen (hence we will not charge them), and get redirected to the Merchant website with the orderToken and a status of "CANCELLED"
  6. If the merchant is able to fulfil the order, the merchant calls the Capture Payment endpoint to capture the payment, within the timeout limit.

  • If our risk engine has approved the order, and the customer was charged successfully, the response will be APPROVED status
  • If our risk engine has declined the order or the customer was not charged successfully, the response will be an error
  • If the capture is outside the timeout limit (15 minutes) the response will be an error