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 built an 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
-
Make a /payments request from your server, specifying:
-
paymentMethod
: clearpay -
shopperName: the shopper's full name.
-
shopperEmail: the shopper's email address.
-
: the shopper's phone number.Optional
-
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.
Expand viewCopy link to code blockCopy codecurl https://checkout-test.adyen.com/v68/payments \ -H 'x-api-key: ADYEN_API_KEY' \ -H 'content-type: application/json' \ -d '{ "paymentMethod":{ "type":"clearpay" }, "amount":{ "value":1000, "currency":"GBP" }, "shopperName":{ "firstName":"Simon", "lastName":"Hopper" }, "shopperEmail":"s.hopper@example.com", "shopperReference":"YOUR_UNIQUE_SHOPPER_ID", "reference":"YOUR_ORDER_REFERENCE", "merchantAccount":"ADYEN_MERCHANT_ACCOUNT", "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..", "countryCode":"GB", "telephoneNumber":"+44 203 936 4029", "billingAddress":{ "city":"London", "country":"GB", "houseNumberOrName":"8-10", "postalCode":"SW1H 0BG", "stateOrProvince":"Westminster", "street":"Broadway" }, "deliveryAddress":{ "city":"London", "country":"GB", "houseNumberOrName":"8-10", "postalCode":"SW1H 0BG", "stateOrProvince":"Westminster", "street":"Broadway" }, "lineItems":[ { "description":"Shoes", "quantity":"1", "amountIncludingTax":"400", "amountExcludingTax": "331", "taxAmount": "69", "id":"Item #1" }, { "description":"Socks", "quantity":"2", "amountIncludingTax":"300", "amountExcludingTax": "248", "taxAmount": "52", "id":"Item #2" } ] }' -
-
The /payments response includes the
action
object with information that you must use to redirect the shopper.
{ "resultCode":"RedirectShopper", "action":{ "paymentMethodType":"clearpay", "method":"GET", "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...", "type":"redirect" } }
Handle the redirect
-
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.
-
-
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-decodedredirectResult
returned when the shopper was redirected back to your site.
/payments/details requestExpand viewCopy link to code blockCopy codecurl https://checkout-test.adyen.com/v68/payments/details \ -H 'x-api-key: ADYEN_API_KEY' \ -H 'content-type: application/json' \ -d '{ "details": { "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ==" } }' -
In the response note the following:
resultCode
: use this to present the result to your shopper.pspReference
: our unique identifier for the transaction.
/payments/details responseExpand viewCopy link to code blockCopy code{ "resultCode": "Authorised", "pspReference": "V4HZ4RBFJGXXGN82" }
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
:price and product information for the items that the shopper should pay for.Optional
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.
{ "originalReference":"COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE", "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "modificationAmount":{ "currency":"GBP", "value":"700" }, "additionalData":{ "openinvoicedata.numberOfLines":"2", "openinvoicedata.line1.currencyCode":"GBP", "openinvoicedata.line1.description":"Shoes", "openinvoicedata.line1.itemAmount":"331", "openinvoicedata.line1.itemVatAmount":"69", "openinvoicedata.line1.numberOfItems":"1", "openinvoicedata.line2.currencyCode":"GBP", "openinvoicedata.line2.description":"Socks", "openinvoicedata.line2.itemAmount":"248", "openinvoicedata.line2.itemVatAmount":"52", "openinvoicedata.line2.numberOfItems":"1", }, "reference":"YOUR_CAPTURE_REFERENCE" }
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
:price and product information about the returned items.Optional
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.
{ "merchantAccount":"YOUR_MERCHANT_ACCOUNT", "originalReference":"COPY_PSP_REFERENCE_FROM_AUTHORISE_RESPONSE", "modificationAmount":{ "currency":"GBP", "value":"400" }, "additionalData":{ "openinvoicedata.numberOfLines":"1", "openinvoicedata.line1.currencyCode":"GBP", "openinvoicedata.line1.description":"Shoes", "openinvoicedata.line1.itemAmount":"331", "openinvoicedata.line1.itemVatAmount":"69", "openinvoicedata.line1.numberOfItems":"1" }, "reference":"YOUR_REFUND_REFERENCE" }
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.