Clearpay

Introduction

Clearpay is a credit payment provider that allows customers to spread the cost of their order value over multiple payments. Aurora's integration with Clearpay allows your customers to make use of Clearpay's payment plans when placing orders via the Aurora Front-end.

❗️

When using the Clearpay integration, all captures, refunds and voids for orders found in Aurora should be performed via Aurora. While the Clearpay Retailer Portal does present the option to refund and void orders, these actions will not be reflected in Aurora if performed from the Clearpay Portal and so this should be avoided if at all possible.

Initial Setup

🚧

The Clearpay Integration uses the Aurora Microservice (MS) framework, and as such must be set-up in advance by Aurora Commerce before you can use it with your store.

Doing this requires a one-off development to setup and configure your store to use the Clearpay MS, after which, you can then configure the integration at your own leisure.

If you have not yet had (or do not know if you have had) the Clearpay MS set up and configured for your store, then please contact Aurora Commerce for more details regarding how to get this done.

In order to configure your Clearpay MS, you will need to request the following details from Clearpay:

• Clearpay API endpoint prefix
• Clearpay Merchant ID
• Clearpay API key

Please request these details for both Staging (Test) and Production (Live) environments, so that you can test your integration before go live.

Aurora Backend Settings

Once the Clearpay MS has been setup and enabled for your store, you can follow these steps to allow your customers to use it on your front-end checkout.

Enable the Clearpay Microservice

Store > Settings > Feeds > Microservice > Proxy Clearpay

Configure visibility of the Clearpay payment option (in conjunction with the "Payment Types Accepted at Checkout" setting):

🚧

This 'visibility behaviour' is enforced entirely within the Aurora Front-end Templates and so is the default behaviour offered by the Aurora Demo Example Front-end Templates, but may not be how your own Front-end Templates are configured.

If you run into issues with payment option visibility, please check your Front-end Templates for the appropriate logic.

Payment Types Accepted at Checkout

Store > Settings > Payment Providers

Configure Aurora to accept orders using the Clearpay payment type:

🚧

This 'visibility behaviour' is enforced entirely within the Aurora Front-end Templates and so is the default behaviour offered by the Aurora Demo Example Front-end Templates, but may not be how your own Front-end Templates are configured.

If you run into issues with payment option visibility, please check your Front-end Templates for the appropriate logic.

Microservice Settings

Store > Microservice > Proxy Clearpay

Configure the Clearpay MS to communicate with the Clearpay API:

Minimum and Maximum order values

Clearpay has restrictions on the values that can be passed through to its payment service. These take the form of maximum and minimum order values. When these are set (in Clearpay) it will result in payments being rejected if the total order value does not fall within these limits.

👍

If you wish to change these limits, you must do so from the Clearpay Administrative Portal as Aurora does not manage these limits for you.

To help ensure that the customer experience is a smooth as possible, Aurora imports these values once a day for you in order to allow you to tailor your checkout process based on the order value and the availability of credit from Clearpay.

📘

For more detail on how to tailor your checkout as suggested here, please see the Frontend Template Integration > Checking the Clearpay Payment Limits section of this support article.

You are able to view the values currently imported into Aurora (which are updated once a day from Clearpay) from within the Aurora Back-end under the Proxy Clearpay setting section.

Aurora Service Errors

Content > Site Text

User error messages from the Aurora payment service that can be changed and translated using the Aurora Site Text system:

Frontend Template Integration

Displaying the Clearpay Payment Option

In order to use the Clearpay MS within your checkout, you must simply include the following values within your checkout submission:

Example template:

{if $config.microservice_proxyclearpay_live}
    {include file="checkout/clearpay/payment-methods.tpl.html"}
{/if}

🚧

Find the content of the "checkout/clearpay/payment-methods.tpl.html" file within the Aurora Demo templates.

Checking the Clearpay Payment Limits: Payment Limits Callback

🚧

Before you begin, please be aware that the Aurora Demo Front-end Templates already have a working implementation of this behaviour, enabling and disabling Clearpay based on the Ajax call to Aurora. This being so, you need only read the following for your reference should you wish to implement your own solution.

👍

Find the existing implementation of this in the templates/example.com/_js/clearpay.payments.js file for your reference.

Request Data

To make a call to the Aurora Callback endpoint to fetch the limits, you should make a request to the following endpoint with the parameters as described below:

Endpoint: /checkout/payment-client-callback

Method: POST

Response Data

You can use the Aurora Client Callback to fetch the following information:

Format: JSON

Notes for Testing

When testing the Clearpay integration, you should keep the following in mind.

SMS Mobile Phone Verification

During testing, using your ClearPay Test Account, you may run into the need to verify your mobile phone number. When this occurs, simply use 111111 as the verification code.