Accept Online banking Poland payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Online banking Poland to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Online banking Poland integration:
- Make sure that you have set up your back end implementation.
- Add Online banking Poland in your test Customer Area.
Build your payment form for Online banking Poland
To show Online banking Poland in your payment form, you need to:
- Show a list of available banks to your shopper.
- After the shopper selects a bank, pass the corresponding Issuer value to your server. You'll need this to make a payment.
We recommend you do not use a hardcoded form, because the list of Online banking Poland issuers is very long and changes relatively often, and not all issuers are online all the time.
Because of the large number of small issuers, we recommend you use a dynamically generated form showing the top 10 issuers and an option to show more issuers if the shopper's bank is not listed.
We provide logos for Online banking Poland and the issuing banks, which you can use on your payment form. For more information, refer to Downloading logos.
You can get the issuer list from the /paymentMethods response, as explained in the API-only integration guide.
In your /paymentMethods request, specify:
- countryCode: PL
- amount.currency: PLN
The list of issuing banks are included in the object with type
: dotpay.
Make a payment
In your /payments request, specify:
paymentMethod.type
: dotpaypaymentMethod.issuer
: The shopper's bank. Specify this with the Issuer value that corresponds to this bank.- returnUrl: The URL where the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.
curl https://checkout-test.adyen.com/v68/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":"http://my.url.com/done"
}'
# 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 => "http://my.url.com/done",
: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("http://my.url.com/done");
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" => "http://my.url.com/done",
"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': 'http://my.url.com/done',
'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 = @"http://my.url.com/done",
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: "http://my.url.com/done"
}).then(res => res);
The /payments response contains an action
object with the information needed to redirect the shopper.
Handle the redirect
-
To complete the payment, redirect the shopper to the
action.url
returned in the /payments response.When using the HTTP GET method:
For security reasons, when displaying the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView. -
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-decodedredirectResult
returned when the shopper was redirected back to your site.
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 Online banking Poland 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 Online banking Poland payments, you need to submit a request for Dotpay in your live Customer Area.