Clearpay iOS Redirect Component integration

Use the Redirect Component to handle the redirect to Clearpay.

On this page, you can find additional configuration for adding Clearpay to your Components integration.

Before you begin

This page assumes you have already:

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 the endpoint you integrated with:

This is the default with Components v5.0.0 or later.

Parameter name	Required	Description
shopperName		The shopper's full name.
shopperEmail		The shopper's email address.
shopperReference		A unique reference to identify the shopper. Minimum length: three characters.
countryCode		The shopper's country/region.
billingAddress		The postal address to be included on the invoice.
deliveryAddress		The postal address where the goods will be shipped.
lineItems		Price and product information about the purchased items.
telephoneNumber		The shopper's telephone number, if provided.

Component configuration

v5.0.0 or later

If your integration uses iOS Components v5.0.0 or later, configure and create an instance of the Clearpay Component:

v4.x.x

If your integration uses an earlier version of iOS Components:

There are no configuration steps specific to Clearpay required for Components.

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 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:

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

Clearpay developer documentation	Description
Test Environment (Sandbox)	More information about how to get access to the sandbox environment.
Customer Accounts	Learn how to create a test Clearpay shopper account.
Test cards	List of available Clearpay test cards to test different payment flows.

In the Clearpay sandbox environment, you will see Adyen as the merchant name. When you go live, this will change to your own merchant name.

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.