1. Create Checkout

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

1. Get Configuration

• GET /v2/configuration

This call should be done as apart of 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. Check with your Clearpay contact to change your minimum or maximum range.

2. Create Checkout

• POST /v2/create-checkout

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

1. Customer Information
2. Order Details
3. Order Total
4. Shipping Information
5. 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 customer’s pre-approval process.

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

The token is used with the Afterpay.js JavaScript library to direct the customer to the Clearpay checkout flow.

After the customer completes the checkout flow they are returned to the Merchant website URL provided in the Create Checkout request. If using the redirect method the URL has status appended to the Merchant URL. For Example:

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

📘

A popup method is also available which uses a postMessage to communicate the status and token.

Choose When You Want to Capture the Order

Depending on your business model, you will either use immediate payment or deferred payment. Immediate payment begins the customer's payment plan immediately, and deferred payment places a hold on funds until you are ready to begin fund capture.