Clearpay Web Component integration

This page explains how to add Clearpay to your existing Web Components integration.

Requirements

Select the server-side flow that your integration uses:

Also 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.

API reference

Select which endpoint you are using:

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="clearpay-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

• Your instance of AdyenCheckout.

const clearpay = new Redirect(checkout, { type: 'clearpay' }).mount('#clearpay-container');

const clearpayComponent = checkout.create('clearpay').mount('#clearpay-container');

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.

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:

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.

Refunds and cancellations

If a payment has not yet been captured, you can cancel it. If a payment has already been captured and you want to return the funds to the shopper, you need to refund the payment.

Partial refunds

To partially refund a payment, in your /payments/{paymentPspReference}/refunds request specify:

• modificationAmount: the amount to be refunded to the shopper.
• additionalData.openinvoicedata:
  Optional
  price and product information about the returned items.

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

The following example shows how to make a partial refund request if the shopper returned the shoes included in the original payment request.

Discounts

To offer discounts, your payment request must include the negative amount to be added to the original price. The following example shows how to specify a discount of 1 GBP on Item #2:

{
  "amount":{
     "value":800,
     "currency":"GBP"
  },
  ...
  "lineItems":[

     {
        "description":"Test Clearpay 1",
        "quantity":"1",
        "amountIncludingTax":"400",
        "id":"Item #1"
     },
     {
        "description":"Test Clearpay 2",
        "quantity":"2",
        "amountIncludingTax":"300",
        "id":"Item #2"
     }

     {
        "description":"Discount",
        "quantity":"2",
        "amountIncludingTax":"-100",
        "id":"Item #2 Discount"
     }
  ]
}

Test and go live

To test Clearpay payments, you need to use the Clearpay sandbox environment and create a test Clearpay shopper account. Clearpay offers separate sandbox environments and test details based on country and region.
Follow the links to the Clearpay developer documentation for more details.

When you have set up your sandbox environment, and created your Clearpay test shopper account, you can make a test payment. You can check the status of test payments in your Customer Area > Transactions > Payments.

Before you can accept live Clearpay payments, you need to submit a request for Clearpay in your live Customer Area.

See also