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:
Before you begin
This page explains how to add Dotpay to your existing iOS Components integration. The iOS 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:
- Make sure that you have set up your back end implementation for making API requests.
- Add Dotpay in your test Customer Area.
Show Dotpay in your payment form
Include Dotpay in the list of available payment methods.
-
Specify in your /paymentMethods request:
- countryCode: PL.
- amount.currency: PLN.
- channel: Specify iOS.
-
Decode the
/paymentMethods
response with thePaymentMethods
structure.
Findlet paymentMethods = try JSONDecoder().decode(PaymentMethods.self, from: paymentMethodsResponse)
paymentMethods.type
dotpay and put it into an object. For example,dotpayPaymentMethod
. - Initialize the Dotpay Component:
let dotpayComponent = DotpayComponent(paymentMethod: dotpayPaymentMethod) // The client key from your Customer Area. dotpayComponent.clientKey = "YOUR_CLIENT_KEY" dotpayComponent.delegate = self // When you're ready to go live, change this to .live or to other environment values. // Environment values are described in https://adyen.github.io/adyen-ios/Docs/Structs/Environment.html dotpayComponent.environment = .test // In this example, the Pay button will display 10 EUR. // The value is in minor units. Change the currencyCode to the currency for the Dotpay Component. dotpayComponent.payment = Payment(amount: Payment.Amount(value: 1000, currencyCode: "EUR")) present(dotpayComponent.viewController, animated: true)
Make a payment
When the shopper proceeds to pay, the Component invokes the didSubmit
method containing the data.paymentMethod
from the PaymentComponentDelegate
.
- Pass the
data.paymentMethod
to your server. - From your server, make a /payments request, specifying:
paymentMethod.type
: Thedata.paymentMethod
from your client app.returnUrl
: The website or app where the shopper should be taken back to after the redirect.
curl https://checkout-test.adyen.com/v66/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" => "my-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:
-
action.method
: GET. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to yourreturnURL
using the same method.
{
"resultCode":"RedirectShopper",
"action":{
"method":"GET",
"paymentData":"Ab02b4c0!BQABAgCSZT7t...",
"paymentMethodType":"dotpay",
"type":"redirect",
"url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=..."
},
"details":[
{
"key":"redirectResult",
"type":"text"
}
],
...
}
- Pass the
action
object to your client app. You need this to initialize the Redirect Component.
Handle the redirect
- Use the Redirect Component to redirect the shopper to the issuing bank's app or website.
-
After the shopper returns to your app, make a POST /payments/details request from your server and provide the
data
from thedidProvide
method from your client app.
You receive a response containing:
-
resultCode
: Use this to present the 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 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. |
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.