Dotpay Drop-in integration

Add Dotpay to your existing iOS Drop-in integration.

Our iOS Drop-in renders Dotpay in your payment form, and redirects the shopper to their selected bank's website or app to complete the payment.

When making a Dotpay payment, you additionally need to:

Handle the redirect result after the shopper returns to your website.

Before you begin

This page explains how to add Dotpay to your existing iOS Drop-in integration. The iOS Drop-in integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Drop-in integration guide.

Before starting your Dotpay integration:

Make sure that you have set up your back end implementation, and added Drop-in to your payment form.
Add Dotpay in your test Customer Area.

Show Dotpay 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 Dotpay in your payment form, you need to specify in your /paymentMethods request:

countryCode: PL
amount.currency: PLN

After the shopper selects a payment method and provides payment details, Drop-in invokes the didSubmit method which contains data.paymentMethod. Pass data.paymentMethod to your server and make a payment request.

Make a payment

When the shopper proceeds to pay, Drop-in invokes the didSubmit method which contains data.paymentMethod.

Pass data.paymentMethod to your server.
From your server, make a /payments request, specifying:
- paymentMethod: The state.data.paymentMethod from the didSubmit event from your front end.
- reference: Your unique reference for this payment.
- amount: The amount that the shopper needs to pay.
- returnUrl: The URL the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.

https://docs.adyen.com/payment-methods/dotpay/ios-drop-in#dotpay-payments

curl https://checkout-test.adyen.com/v67/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":"my-app://"
}'

# 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 => "my-app://",
  :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("my-app://");

    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" => "hmy-app://",
  "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': 'my-app://',
   '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 = @"my-app://",
  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: "my-app://"
}).then(res => res);

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

https://docs.adyen.com/payment-methods/afterpaytouch/ios-drop-in#-payments-response

/payments response

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

Pass the action object to your client app. Drop-in needs this to redirect the shopper to the issuing bank's website or app.

Handle the redirect result

Drop-in redirects the shopper to the issuing bank's app or website where they complete the payment.

To inform Drop-in when the shopper returns to your app, implement the following in your UIApplicationDelegate:

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey: Any] = [:]) -> Bool {
    RedirectComponent.applicationDidOpen(from: url)
    return true
}

After Drop-in completes the action, it invokes the didProvide method.

From your server, make a POST /payments/details request providing the data from the didProvide method from your client app.

https://docs.adyen.com/payment-methods/afterpaytouch/ios-drop-in#-payments-details-request

/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=="
     }
  }'

You receive a response containing:

resultCode: Use this to present the result to your shopper.
pspReference: Our unique identifier for the transaction.
https://docs.adyen.com/payment-methods/afterpaytouch/ios-drop-in#-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:

resultCode	Description	Action to take
Authorised	The payment was successful.	Inform the shopper that the payment has been successful. You will receive the funds in 2-3 days.
Cancelled	The shopper cancelled the payment while on their bank's website.	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 for the Dotpay payments network to confirm this.	Inform the shopper that you've received their order, and are waiting for the payment to be completed. You will receive the final result of the payment in an AUTHORISATION notification.
Refused	The payment was refused by the shopper's bank.	Ask the shopper to try the payment again using a different payment method.

If a shopper completed the payment but failed to return to your website or app, you will receive the outcome of the payment in an AUTHORISATION notification.

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.