Dotpay Android Component

Our Dotpay Component renders Dotpay in your payment form and collects your shopper's selected bank.

When making a Dotpay payment, you additionally need to:

• Handle the redirect.

Before you begin

This page explains how to add Dotpay to your existing Android Components integration. The Android 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 Dotpay integration:

1. Make sure that you have set up your back end implementation for making API requests.
2. Add Dotpay in your test Customer Area.

Show Dotpay in your payment form

To show Dotpay Component in your payment form, you need to:

1. Specify in your /paymentMethods request:
   • countryCode: PL
   • amount.currency: PLN
2. Deserialize the response from the /paymentMethods call and get the object with type: dotpay.

3. Add the Dotpay Component:

   a. Import the Dotpay Component to your build.gradle file.

   implementation "com.adyen.checkout:dotpay-ui:<latest-version>"

   Check the latest version on GitHub.

   b. Create a dotpayConfiguration object:

   val dotpayConfiguration =
   DotpayConfiguration.Builder(Locale.getDefault(), resources.displayMetrics, Environment.TEST)
   .build()

   c. Initialize the Dotpay Component. Pass the payment method object and the dotpayConfiguration object.

   val dotpayComponent = DotpayComponent.PROVIDER.get(this@YourActivity, dotpay, dotpayConfiguration)

   d. Add the Dotpay Component view to your layout.

   <com.adyen.checkout.dotpay.DotpaySpinnerView
       android:layout_width="wrap_content"
       android:layout_height="wrap_content"/>

   e. Attach the Component to the view to start getting your shopper's payment details.

   DotpaySpinnerView.attach(dotpayComponent, this@YourActivity)

   f. When shoppers enter their payment details, you start receiving updates. If isValid is true and the shopper proceeds to pay, pass the paymentComponentState.data.paymentMethod to your server and make a payment request.

   dotpayComponent.observe(this@coreActivity, Observer {
     if (it?.isValid == true) {
         // When the shopper proceeds to pay, pass the `it.data` to your server to send a /payments request
     }
   })

Make a payment

When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod.

1. Pass the paymentComponentState.data.paymentMethod to your server.
2. From your server, make a /payments request, specifying:
   • paymentMethod.type: The paymentComponentState.data.paymentMethod from your client app.
   • returnURL: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).

curl https://checkout-test.adyen.com/v52/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
  "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
  "reference":"YOUR_ORDER_NUMBER",
  "amount":{
    "currency":"PLN",
    "value":1000
  },
  "{hint:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
    "type":"dotpay",
    "issuer":"92"
  },
  "returnUrl":"adyencheckout://your.package.name"
}'

# 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({
  :amount => {
    :currency => "PLN",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "dotpay",
    :issuer => "92"
  },
  :returnUrl => "adyencheckout://your.package.name",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
})

// 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("PLN");
    amount.setValue(15000L);
    paymentsRequest.setAmount(amount);

    DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
    paymentMethodDetails.setIssuer("92");
    paymentMethodDetails.setType("dotpay");
    paymentsRequest.setPaymentMethod(paymentMethodDetails);

    paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    paymentsRequest.setReturnUrl("adyencheckout://your.package.name");

    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 = array(
  "amount" => array(
    "currency" => "PLN",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "dotpay",
    "issuer" => "92"
  ),
  "returnUrl" => "adyencheckout://your.package.name",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$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({
   'amount': {
      'value': 1000,
      'currency': 'PLN'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'dotpay',
      'issuer': '92'
   },
   'returnUrl': 'adyencheckout://your.package.name',
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
})

// 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 amount = new Model.Checkout.Amount("PLN", 1000);
var details = new Model.Checkout.DefaultPaymentMethodDetails{
  Type = "dotpay",
  Issuer = "92"
};
var paymentRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"adyencheckout://your.package.name",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);

// 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: "PLN", value: 1000 },
    paymentMethod: {
        type: 'dotpay',
        issuer: '92'
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    returnUrl: "adyencheckout://your.package.name"
}).then(res => res);

The /payments response contains:

• action: Object containing information about the redirect.

{
 "resultCode": "RedirectShopper",
 "action": {
     "data": {},
     "method": "GET",
     "paymentData": "Ab02b4c0!BQA...",
     "paymentMethodType": "dotpay",
     "type": "redirect",
     "url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=dotpay&currencyCode=PLN..."
 },
 "details": [
     {
         "key": "payload",
         "type": "text"
     }
 ],
 "paymentData": "Ab02b4c0!BQA...",
 "redirect": {
     "method": "GET",
     "url": "https://test.adyen.com/hpp/skipDetails.shtml?brandCode=dotpay&currencyCode=PLN..."
 }
}

3. Pass the action object to your client app. You need this to initialize the Redirect Component.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to the issuing bank's app or website.

2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

   • paymentData: The value from the /payments response.
   • details: The actionComponentData.details object from the Redirect Component.
   https://docs.adyen.com/payment-methods/gcash/android-component#-payments-details-request

   /payments/details request

   {
     "{hint:Value from the /payments response}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
     "{hint:Value from actionComponentData.details}details{/hint}":{
       "payload":"Ab02b4c0!BQABAgCW5sxB4e/=="
     }
   }

   You receive a response containing:

   • resultCode: Use this to present the payment result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/gcash/android-component#-payments-details-response

   /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 Dotpay are:

Test and go live

Before accepting live Dotpay online banking payments, test your integration using test.adyen.com endpoints in your test environment.
Once you send a test payments request, you'll be redirected to Dotpay. You need to enter your name and email in order to receive confirmation from Dotpay. You don't need any specific test credentials to do test payments.
Check the status of Dotpay test payments in your Customer Area > Transactions > Payments.

Before you can accept live Dotpay payments, you need to submit a request for Dotpay in your live Customer Area.

See also