Clearpay Android Drop-in integration

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.

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

Requirements

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:

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

1. Pass the paymentComponentData.paymentMethod to your server.

2. From your server, make a /payments request, specifying:

   • paymentMethod: the paymentComponentData.paymentMethod from Drop-in.

   • shopperName: the shopper's full name. 

   • shopperEmail: the shopper's email address.  

   • telephoneNumber

     Optional
     : 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.  

3. In the /payments response, note the action object. This contains 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: The actionComponentData.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:

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

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, in your  /payments/{paymentPspReference}/captures request specify:

• 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:

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.

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

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

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