Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Dotpay for API only

Add Dotpay to an existing API-only integration.

Accept Dotpay 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 Dotpay 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 Dotpay integration:

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

Build your payment form for Dotpay

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

  1. Show a list of available banks to your shopper.
  2. 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 Dotpay 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 Dotpay 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:

The list of issuing banks are included in the object with type: dotpay.

Make a payment

In your /payments request, specify:

  • paymentMethod.type: dotpay
  • paymentMethod.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.

{
  "amount": {
   "currency": "PLN",
   "value": 1000
  },
  "reference": "YOUR_ORDER_NUMBER",
  "paymentMethod": {
   "type": "dotpay",
   "issuer": "92"
  },
  "returnUrl": "http://my.url.com/done",
  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
}

The /payments response contains:

  • resultCode: RedirectShopper
  • details: Array that contains the key parameter name and the corresponding data type that you should expect when the shopper is redirected to your returnURL. You need to submit this value in your /payments/details request when handling the redirect.
  • action: Object containing information about the redirect.
  • action.paymentData: Value that you need to submit in your /payments/details request when handling the redirect.
  • action.url: Link to where you should redirect your shopper.
  • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
    The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

{
 "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..."
 }
}

Handle the redirect

To complete a Dotpay payment, you need to redirect the shopper to the issuer's website. After the shopper is redirected back to your website or app, make a /payments/details request to check the payment result.

For more information and detailed instructions, refer to Handling redirects.

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 request that they select a different payment method.
Pending 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.

See also