Are you looking for test card numbers?

Would you like to contact support?

Atenção, esta página não se encontra disponível em Português
Payment-method icon

Clearpay Drop-in integration

Add Clearpay to your existing Drop-in integration.

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

Before you begin

This page assumes you've already:

When making an Clearpay payment, you also need to:

  1. Collect shopper details, and specify these in your payment request. Clearpay uses these for risk checks.
  2. Provide information about the purchased items.
  3. Make sure you use a supported combination of country and currency.

API reference

Select which endpoint you're integrating:

This is the default with Components v5.0.0 or later.
Parameter name Required Description
shopperName -white_check_mark- The shopper's full name.
shopperEmail -white_check_mark- The shopper's email address.
shopperReference -white_check_mark- A unique reference to identify the shopper. Minimum length: three characters.
countryCode -white_check_mark- The shopper's country.
billingAddress -white_check_mark- The postal address to be included on the invoice.
deliveryAddress -white_check_mark- The postal address where the goods will be shipped.
lineItems -white_check_mark- Price and product information about the purchased items.  
telephoneNumber The shopper's telephone number, if provided.
curl https://checkout-test.adyen.com/v68/sessions \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "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"
     }
  ]
}'
Client client = new Client("Your X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

CreateCheckoutSessionRequest sessionRequest = new CreateCheckoutSessionRequest();
sessionRequest.setMerchantAccount("YOUR_MERCHANT_ACCOUNT");
sessionRequest.setReference("YOUR_ORDER_REFERENCE");

Amount amount = new Amount();
amount.setCurrency("GBP");
amount.setValue(1000L);
sessionRequest.setAmount(amount);

sessionRequest.setCountryCode("GB");
sessionRequest.setTelephoneNumber("+44 203 936 4029");
sessionRequest.setShopperEmail("s.hopper@example.com");

Name shopperName = new Name();
shopperName.setFirstName("Simon");
shopperName.setLastName("Hopper");
sessionRequest.setShopperName(shopperName);

sessionRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID");

Address billingAddress = new Address();
billingAddress.setCity("London");
billingAddress.setCountry("GB");
billingAddress.setHouseNumberOrName("8-10");
billingAddress.setPostalCode("SW1H 0BG");
billingAddress.setStateOrProvince("Westminster");
billingAddress.setStreet("Broadway");
sessionRequest.setBillingAddress(billingAddress);

Address deliveryAddress = new Address();
deliveryAddress.setCity("London");
deliveryAddress.setCountry("GB");
deliveryAddress.setHouseNumberOrName("8-10");
deliveryAddress.setPostalCode("SW1H 0BG");
deliveryAddress.setStateOrProvince("Westminster");
deliveryAddress.setStreet("Broadway");
sessionRequest.setDeliveryAddress(deliveryAddress);

sessionRequest.returnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

LineItem lineItem1 = new LineItem();
lineItem1.setQuantity(1L);
lineItem1.setAmountExcludingTax(331L);
lineItem1.setDescription("Shoes");
lineItem1.setId("Item #1");
lineItem1.setTaxAmount(69L);
lineItem1.setAmountIncludingTax(400L);

LineItem lineItem2 = new LineItem();
lineItem2.setQuantity(2L);
lineItem2.setAmountExcludingTax(248L);
lineItem2.setDescription("Socks");
lineItem2.setId("Item #2");
lineItem2.setTaxAmount(52L);
lineItem2.setAmountIncludingTax(300L);

List<LineItem> lineItems = new ArrayList<LineItem>();
lineItems.add(lineItem1);
lineItems.add(lineItem2);
sessionRequest.setLineItems(lineItems);

CreateCheckoutSessionResponse sessionResponse = checkout.sessions(sessionRequest);
var paymentRequest = new PaymentRequest
{
    MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
    Reference = "YOUR_ORDER_REFERENCE",
    Amount = {
    Currency = "GBP",
    Value = 1000
  },
    CountryCode = "GB",
    TelephoneNumber = "+44 203 936 4029",
    ShopperEmail = "s.hopper@example.com",
    ShopperName = {
    FirstName = "Simon",
    LastName = "Hopper"
  },
    ShopperReference = "YOUR_UNIQUE_SHOPPER_ID",
    BillingAddress = {
    City = "London",
    Country = "GB",
    HouseNumberOrName = "8-10",
    StateOrProvince = "Westminster",
    PostalCode = "SW1H 0BG",
    Street = "Broadway"
  },
    DeliveryAddress = {
    City = "London",
    Country = "GB",
    HouseNumberOrName = "8-10",
    StateOrProvince = "Westminster",
    PostalCode = "SW1H 0BG",
    Street = "Broadway"
  },
    ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
    LineItems = new System.Collections.Generic.List<LineItem> {
    new LineItem {
      Quantity = 1,
        AmountExcludingTax = 331,
        Description = "Shoes",
        Id = "Item #1",
        TaxAmount = 69,
        AmountIncludingTax = 400
    },
    new LineItem {
      Quantity = 2,
        AmountExcludingTax = 248,
        Description = "Socks",
        Id = "Item #2",
        TaxAmount = 52,
        AmountIncludingTax = 300
    }
  }
};

Drop-in configuration

There is no Clearpay specific configuration for Drop-in.

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.

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

/refund 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, 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 that are relevant for your test integration in the table below to test Clearpay payments.

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

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