Our Dotpay Component renders Dotpay in your payment form. As with other redirect payment methods, you need to use createFromAction
to redirect the shopper, and handle the redirect after the shopper returns to your website.
Before you begin
This page explains how to add Dotpay to your existing Web Components integration. The Web 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, and created an instance of
AdyenCheckout
. -
Add Dotpay in your Customer Area.
Show Dotpay in your payment form
To present the Dotpay Component in your payment form:
- From your server, make a POST /paymentMethods request specifying:
- countryCode: PL
- amount.currency: PLN
-
Pass the full response from the /paymentMethods call as the
paymentMethodsResponse
object when creating an instance of theAdyenCheckout
. -
Add the Dotpay Component:
a. Create a DOM element for Dotpay, placing it where you want the form to be rendered:
<div id="dotpay-container"></div>
b. Create an instance of the Dotpay Component, and mount it. You can also include optional configuration for presenting the list of issuing banks.
const dotpayComponent = checkout.create("dotpay", { //Optional configuration showImage: false, // Optional. Set to **false** to remove the bank logos from the Dotpay form. issuer: "73" // Optional. Set this to an **id** of a Dotpay issuer to preselect it. }).mount("#dotpay-container");
When the shopper selects the payment method, the Component calls the
onChange
event, or theonSubmit
event if you're using the Pay button. The event contains astate.data
object including the shopper's selected payment option. If your integration is set up correctly, thestate.data
is passed on to your server.
Make a payment
From your server, make a POST /payments request, specifying:
paymentMethod
: Thestate.data.paymentMethod
from theonChange
oronSubmit
event from your front end.reference
: Your unique reference for this payment.returnUrl
: The URL where the shopper will be redirected back to after completing the payment. The URL should include the protocol:http://
orhttps://
. For example,https://your-company.com/checkout/
. You can also include your own additional query parameters, for example, shopper ID or order reference number.
Here is how you would make a payment request for 10 PLN.
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":"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:
-
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"
}
],
...
}
If your integration is set up correctly, the action
object is passed from your server to the client, and the action.paymentData
temporarily stored on your server.
Handle the redirect result
Handling the redirect works the same way for all redirect payment methods:
-
Call
createFromAction
, passing theaction
object from the previous step. This will return a new Component that you need to mount:
The Component redirects the shopper to their bank's website or app to complete the payment.checkout.createFromAction(action).mount('#my-container');
-
After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:
-
paymentData
: The value from the/payments
response. -
details
: Object that contains the URL-decodedredirectResult
returned when the shopper was redirected back to your site.
-
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 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.