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.
Before you begin
These instructions explain how to add Clearpay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your integration:
- Make sure that you have set up your back end implementation.
- Add Clearpay in your test Customer Area.
Build your payment form for Clearpay
If you're using /paymentMethods to show which payment methods are available to the shopper,
specify the following combination of countryCode and amount.currency:
Country | countryCode |
amount.currency |
---|---|---|
United Kingdom | GB | GBP |
We provide an 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.
- 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.
curl https://checkout-test.adyen.com/v66/payments \
-H "x-API-key: YOUR_X-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":"YOUR_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 contains:
-
action.url
: Link to where you should redirect your shopper. -
action.method
: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to yourreturnURL
using the same method.
{
"resultCode":"RedirectShopper",
"action":{
"method":"GET",
"paymentData":"Ab02b4c0!BQABAgCSZT7t...",
"paymentMethodType":"clearpay",
"type":"redirect",
"url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=..."
},
"details":[
{
"key":"redirectResult",
"type":"text"
}
],
...
}
Handle the redirect
-
To complete the payment, redirect the shopper to the
action.url
returned in the /payments response.When using the HTTP GET method:
For security reasons, when displaying 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. -
After the shopper is redirected back to your website or app, check the payment result by making a /payments/details request, specifying:
-
paymentData
: The value your received in the /payments response. -
details.redirectResult
: Object that was returned when the shopper was redirected back to your website or app.
-
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'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 notification. |
|
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 notification 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
By default, all Clearpay payments are captured automatically after authorisation.
If you prefer to capture the payment after the goods have been sent, or when 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.
Capturing the payment is what triggers the invoice to be sent to the shopper.
Partial captures
To partially capture an Clearpay payment, specify in your /capture 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 /payments 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.
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 /refund 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 /payments 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":"EUR",
"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, specify in your /payments request the negative amount to be added to the original price. The following example shows how to specify a discount of 10 GBP on Item 2:
{
"amount":{
"value":7850,
"currency":"GBP"
},
...
"lineItems":[
{
"description":"Test Clearpay 1",
"quantity":"1",
"amountIncludingTax":"4550",
"id":"Item #1"
},
{
"description":"Test Clearpay 2",
"quantity":"2",
"amountIncludingTax":"2650",
"id":"Item #2"
}
{
"description":"Discount",
"quantity":"2",
"amountIncludingTax":"-1000",
"id":"Item #2 Discount"
}
]
}
Test and go live
To test Clearpay payments, you need a test shopper account in the Clearpay sandbox environment.
To create a test account:
- Go to https://portal.sandbox.clearpay.co.uk/
- Enter a real email address and click Continue. You'll get confirmations of payments and refunds like any other shopper on this email address.
- Enter any mobile telephone number that is formatted correctly, and click Continue. Check the input box for hints on the format. The phone number won't be used.
- When you are prompted to enter your SMS verification code, enter 111111.
- Follow the instructions on your screen to complete your profile, accept the terms and conditions, and click Continue.
To test payments, add a test card to your Clearpay test shopper account.
You can use the card details provided in the Clearpay developer documentation, or use one of the Adyen test cards. Use CVV 000 to simulate authorised payments, or CVV 051 to simulate refused payments.
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.