Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Clearpay Component

Add Clearpay to your existing Components integration.

Our Clearpay Component renders Clearpay in your payment form. As with other redirect payment methods, you need to use createFromAction to redirect the shopper, and handle the redirect after the shopper returns to your website.

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 in your payment request.

Before you begin

This page explains how to add Clearpay to your existing Web Components integration. The Web Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Clearpay integration:

  1. Make sure that you have set up your back end implementation, and created an instance of AdyenCheckout.
  2. Add Clearpay in your Customer Area.

Show Clearpay in your payment form

To present the Clearpay Component in your payment form:

  1. From your server, make a POST /paymentMethods request and specify the following combination of countryCode and amount.currency:

    Country countryCode amount.currency
    United Kingdom GB GBP

  1. Pass the full response from the /paymentMethods call as the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  2. Add the Clearpay Component:
    a. Create a DOM element for Clearpay, placing it where you want the form to be rendered:
    <div id="clearpay-container"></div>

    b. Create and mount an instance of the Clearpay Component using its component name, clearpay. This renders a button on your payment form.

    function handleOnSubmit(state, component) {
        // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
        state.isValid // True or false. Specifies if all the information that the shopper provided is valid.
        state.data // Provides the data that you need to pass in the `/payments` call.
        component // Provides the active component instance that called this event.
    }
    const clearpayComponent =  checkout.create('clearpay', {
        onSubmit: handleOnSubmit // Optional, only if you want to override the onSubmit defined in your AdyenCheckout instance
    }).mount('#clearpay-container');

    When the shopper selects the payment method, the Component calls the onSubmit event, which contains a state.data object including the shopper's selected payment method. If your integration is set up correctly, the state.data is passed on to your server.

Make a payment

From your server, make a POST /payments, specifying:

  • paymentMethod: The state.data.paymentMethod from the onSubmit event from your front end.
  • returnUrl: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol: http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.

Here is how you would make a payment request for 10 GBP:

curl https://checkout-test.adyen.com/v67/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "{hint:`state.data.paymentMethod` from `onSubmit`}paymentMethod{/hint}":{
     "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"
     }
  ]
}'
# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :reference => "YOUR_ORDER_NUMBER",
  :amount => {
    :currency => "GBP",
    :value => 1000
  },
  :paymentMethod => {
    :type => "clearpay"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :countryCode => "GB",
  :shopperName => [
    :firstName => "Simon",
    :lastName => "Hopper"
  ],
  :shopperEmail => "s.hopper@example.com",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID",
  :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"
    }
  ]
})
// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);

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

DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
paymentMethodDetails.setType("clearpay");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");

Name shopperDetails = new Name();
shopperDetails.setFirstName("Simon");
shopperDetails.setLastName("Hopper");

paymentsRequest.setShopperName(shopperDetails);
paymentsRequest.setShopperReference("YOUR_UNIQUE_SHOPPER_ID");
paymentsRequest.setCountryCode("GB");
paymentsRequest.setTelephoneNumber("+44 203 936 4029");
paymentsRequest.setShopperEmail("s.hopper@example.com");

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

paymentsRequest.setBillingAddress(billingAddress);

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

paymentsRequest.setDeliveryAddress(deliveryAddress);

List<LineItem> lineItems = new ArrayList<>();
lineItems.add(
        new LineItem()
                .quantity(1L)
                .description("Shoes")
                .id("Item #1")
                .amountIncludingTax(400L)
                .amountExcludingTax(331L)
                .taxAmount(69L)
);
lineItems.add(
        new LineItem()
            .quantity(2L)
            .description("Socks")
            .id("Item #2")
            .amountIncludingTax(300L)
            .amountExcludingTax(248L)
            .taxAmount(52L)
);

paymentsRequest.setLineItems(lineItems);

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = [
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT",
  "reference" => "YOUR_ORDER_NUMBER",
  "amount" => [
    "currency" => "GBP",
    "value" => 1000
  ],
  "paymentMethod" => [
    "type" => "clearpay"
  ],
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "countryCode" => "GB",
  "shopperName" => [
       "firstName" => "Simon",
       "lastName" => "Hopper"
  ],
  "shopperEmail" => "s.hopper@example.com",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID",
  "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"
     ]
    ]
];
$result = $service->payments($params);
#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
   "reference": "YOUR_ORDER_NUMBER",
   "amount": {
      "value": 1000,
      "currency": "GBP"
   },
   "paymentMethod": {
      "type": "clearpay"
   },
   "returnUrl": "https://your-company.com/checkout?shopperOrder=12xy..",
   "countryCode":"GB",
   "shopperName": {
      "firstName":"Simon",
      "lastName":"Hopper"
   },
   "shopperEmail":"s.hopper@example.com",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID",
   "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"
      }
   ]
})
// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
   MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
   Reference = "YOUR_ORDER_REFERENCE",
   PaymentMethod = new DefaultPaymentMethodDetails { Type = "clearpay" },
   Amount = new Model.Checkout.Amount(Currency: "GBP", Value: 1000),
   CountryCode = "GB",
   TelephoneNumber = "+44 203 936 4029",
   ShopperEmail = "s.hopper@example.com",
   ShopperName = new Model.Checkout.Name
   {
       FirstName = "Simon",
       LastName = "Hopper"
   },
   ShopperReference = "YOUR_UNIQUE_SHOPPER_ID",
   BillingAddress = new Model.Checkout.Address
   {
       City = "London",
       Country = "GB",
       HouseNumberOrName = "8-10",
       PostalCode = "SW1H 0BG",
       StateOrProvince = "Westminster",
       Street = "Broadway"
   },
   DeliveryAddress = new Model.Checkout.Address
   {
       City = "London",
       Country = "GB",
       HouseNumberOrName = "8-10",
       PostalCode = "SW1H 0BG",
       StateOrProvince = "Westminster",
       Street = "Broadway"
   },
   ReturnUrl = "https://your-company.com/checkout?shopperOrder=12xy..",
   LineItems = new List<LineItem>
   {
     new LineItem(Quantity:1, Description:"Shoes",Id:"Item #1", AmountIncludingTax:400, AmountExcludingTax: 331, TaxAmount: 69),
     new LineItem(Quantity:2, Description:"Socks",Id:"Item #2", AmountIncludingTax:300, AmountExcludingTax: 248, TaxAmount: 52)
   }
};
return paymentRequest;
}
// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: {
       currency: "GBP",
       value: 1000
    },
    paymentMethod: {
        type: 'clearpay'
    },
    reference: "YOUR_ORDER_NUMBER",
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID",
    merchantAccount: config.merchantAccount,
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    countryCode: "GB",
    shopperName: {
        firstName: "Simon",
        lastName: "Hopper"
    },
    shopperEmail: "s.hopper@example.com",
    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"
       }
    ]
}).then(res => res);

The /payments response contains an action object with the information needed to redirect the shopper.

/payments response
{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"clearpay",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

If your integration is set up correctly, the action object is passed from your server to the client.

Handle the redirect

Handling the redirect works the same way for all redirect payment methods:

  1. Call createFromAction, passing the action object from the previous step. This will return a new Component that you need to mount:
    checkout.createFromAction(action).mount('#my-container');
    The Component redirects the shopper to complete the payment.
  2. 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-decoded redirectResult returned when the shopper was redirected back to your site.
    /payments/details request
    curl https://checkout-test.adyen.com/v67/payments/details \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
       "details": {
         "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
     }
    }'
    The /payments/details response contains:
    • resultCode: Use this to present the payment result to your shopper.
    • pspReference: Our unique identifier for the transaction.
    /payments/details response
    {
        "resultCode": "Authorised",
        "pspReference": "88154795347618C"
    }

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

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.

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

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

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

  1. Go to https://portal.sandbox.clearpay.co.uk/
  2. Enter a real email address and select Continue. You'll get confirmations of payments and refunds like any other shopper on this email address.
  3. Enter any mobile telephone number that is formatted correctly, and select Continue. Check the input box for hints on the format. The phone number won't be used.
  4. When you are prompted to enter your SMS verification code, enter 111111.
  5. Follow the instructions on your screen to complete your profile, accept the terms and conditions, and select 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.

See also