No momento, esta página não está disponível em português
Payment-method icon

Clearpay for API only

Add Clearpay to an existing API-only integration.

Accept Clearpay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Setup steps Before you begin, add Clearpay in your test Customer Area.

Collect shopper details

Ensure that you have a way to collect the following information, which you must include in your Clearpay payment requests:

  • Shopper details. Clearpay uses these for risk checks.
  • Information about the purchased items.

Build your payment form for Clearpay

If you are using /paymentMethods to show which payment methods are available to the shopper,
specify the following combination of countryCode and amount.currency:

Country/region countryCode amount.currency
United Kingdom GB GBP

We provide a Clearpay logo which you can use on your payment form. For more information, refer to Downloading logos.

To perform risk checks, Clearpay requires you to collect the following shopper details:

  • Full name
  • Email address
  • Billing address and delivery address.

Make a payment

  1. Make a /payments request from your server, specifying:

  2. In the /payments response, note the action object. This contains the information needed to redirect the shopper.

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

    • When using the HTTP GET method:
      For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

    • Redirection for mobile integrations:
      For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

  2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

    • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.
  3. In the response note the following:

    • resultCode: use this to present the result to your shopper.
    • pspReference: our unique identifier for the transaction.

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Clearpay are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment was successful.
Cancelled The shopper cancelled the payment. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Pending or
Received
The shopper has completed the payment but the final result is not yet known. It may take minutes or hours to confirm this. Inform the shopper that you have received their order, and are waiting for the payment to be completed.
To know the final result of the payment, wait for the AUTHORISATION webhook.
Refused The payment was refused by Clearpay. Ask the shopper to try the payment again using a different payment method.

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment was successful and proceed with the order.

Capture the payment

Depending on your merchant account configuration, Clearpay payments are captured automatically after authorisation, or manually captured.

If you prefer to capture the payment after the goods have been sent, or if you want to partially capture payments, you need to set up a capture delay or use manual capture. When you use manual capture, Clearpay payments have to be captured within 13 days after authorisation.

During authorisation, the shopper is charged for the first installment. If the payment isn't captured within 13 days, before the second installment, Clearpay cancels the payment and refunds the first installment to the shopper.

For testing purposes, Clearpay authorisations expire in one day. When you use manual capture, you need to capture test Clearpay payments within one day after authorisation.

Partial captures

To partially capture a payment, in your  /payments/{paymentPspReference}/captures request specify:

  • modificationAmount: the amount that the shopper should pay. 
  • additionalData.openinvoicedata:
    Optional
    price and product information for the items that the shopper should pay for.

Although the field names are different, the information in additionalData.openinvoicedata is the same as what you provided in lineItems when making a payment request:

openinvoicedata lineItems Description
itemAmount amountExcludingTax The price for one item, without the tax, in minor units.
itemVatAmount taxAmount The tax amount for one item, in minor units.

The following example shows how to make a partial capture request if the shopper only kept one pair of socks from the two included in the original payment request.

Any unclaimed amount that is left over after partially capturing a payment is automatically cancelled. When your account is enabled for multiple partial captures, the unclaimed amount after an initial capture is not automatically cancelled.

To set up multiple partial captures, contact our Support Team. Multiple partial captures will create a new invoice for each capture. 

Refunds