1. Create a Checkout

What are the API calls required to create a new Clearpay order?

Before creating a Clearpay checkout the merchant needs to retrieve the minimum and maximum order amounts that Clearpay is enabled for. This is done through the Get Configuration endpoint.

1. Get Configuration

This call should be done as a scheduled background process. We recommend calling this endpoint once a day and storing the minimumAmount and maximumAmount server-side.

The merchant should use these values to determine:

  1. The correct Clearpay Messaging to show on the Product Detail pages
  2. Whether Clearpay should be presented as an available payment method.

A request to create a checkout will be declined if the order grand total is less than the minimum, or more than the maximum Clearpay amount. Contact your Clearpay contact to check your eligibility to change your minimum or maximum range.

2. Create Checkout

You will call the Create Checkout endpoint to tell Clearpay information including:

  • Purchase Country
  • Customer Information
  • Order Details
  • Order Total
  • Shipping Information
  • Billing Information
  • URL you would like to direct the customer to when they complete the Clearpay checkout flow

📘

Clearpay uses the Order Total value to calculate the instalment plan and to assist with the consumer’s pre-approval process.

Clearpay will respond with a token used to identify this checkout.
e.g. 004.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju

The token is used with the to direct the consumer to the Clearpay checkout flow with the redirectCheckoutUrl

Clearpay Checkout Final ScreenClearpay Checkout Final Screen

Clearpay Checkout Final Screen

After the consumer completes the checkout flow they will be returned to the Merchant website URL provided in the Create Checkout request. If using the redirect method the URL will have status appended to the Merchant URL. For Example:

  • If the consumer successfully completes the checkout flow:
    www.merchant-example.com/confirm?&status=SUCCESS&orderToken=004.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju
  • If the consumer closes the window:
    www.merchant-example.com/confirm?&status=CANCELLED&orderToken=004.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju

Choose When You Want to Capture the Order

Now that you have a successful pre-approval for the checkout you can either capture the order directly or create an Auth API call to place funds on hold until you are ready to capture.