Clearpay is shutting down their operations in the European Union. As a result, Adyen cannot accept new Clearpay integrations in France, Italy, and Spain.
Clearpay in the United Kingdom is not affected by these changes.
Our Android Drop-in renders Clearpay in your payment form, and redirects the shopper to complete the payment. As with other redirect payment methods, you need to check the payment result after the shopper returns to your app.
When making an Clearpay payment, you also need to:
- Collect shopper details, and specify these in your payment request. Clearpay uses these for risk checks.
- Provide information about the purchased items in your payment request.
Before you begin
This page explains how to add Clearpay to your existing Android Drop-in integration. The Android Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.
Before starting your Clearpay integration:
- Make sure you have set up your back end implementation.
- Add Clearpay in your test Customer Area.
Show Clearpay in your payment form
Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.
To show Clearpay in your payment form, specify the following combination in your /paymentMethods request:
Country | countryCode |
amount.currency |
---|---|---|
France | FR | EUR |
Italy | IT | EUR |
Spain | ES | EUR |
United Kingdom | GB | GBP |
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod
.
-
Pass the
paymentComponentData.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
-
paymentMethod
: ThepaymentComponentData.paymentMethod
from Drop-in. -
shopperName: The shopper's full name.
-
shopperEmail: The shopper's email address.
-
telephoneNumberOptional: The shopper's phone number.
-
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.
-
The /payments response contains an action
object with the information needed to redirect the shopper.
If your integration is set up correctly, the action
object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData
object.
From your server, make a POST /payments/details request providing:
details
: TheactionComponentData.details
object from Drop-in.
You receive a response containing:
resultCode
: Use this to present the payment 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've 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 has been 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 authorisation expires in one day. When you use manual capture, Clearpay payments have to be captured within one day after authorisation.
Partial captures
To partially capture a payment, specify in your /payments/paymentPspReference/captures request:
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 the Clearpay payment has already been captured and you want to return the funds to the shopper, you need to refund it.
Partial refunds
To partially refund a payment, specify in your /payments/paymentPspReference/refunds request:
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, specify in your payment request 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.