Open Banking in the Netherlands

Overview

Open Banking in the Netherlands is a payment method that uses the online banking mechanism for payments through banks in the Netherlands. You can perform purchases through this method by using Payment Page and Gate.

General information

Payment method type online banking
Countries and regions NL
Payment currencies EUR
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Notes
  • it is possible to specify additional parameters when sending a request for processing the purchase by using Payment Page
  • two ways of selecting bank for payment are supported: on the Payment Page side and on the provider side. For more information refer to the ECommPay key account manager
Onboarding and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Open Banking in the Netherlands payment method requires merchant's web service, one of the interfaces and the payment platform of ECommPay, as well as one of the bank services which supports this payment method.



Operations support

  Interfaces Amounts, EUR
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) Minimum Maximum
Purchases + + * *

* Amount limits depend on banks.

Processing scenarios

In the Open Banking in the Netherlands method, to perform a purchase operation, you need to redirect a customer to the provider service.

Figure: Purchase by using Payment Page with bank selection on the Payment Page side



Figure: Purchase by using Payment Page with bank selection on the provider side



Figure: Purchase by using Gate with bank selection on the web service side



Figure: Purchase by using Gate with bank selection on the provider side



Supported banks

Payments through the Open Banking in the Netherlands method are carried out through banks that support the work with this method. Banks have their own identifiers, which are used to initiate purchases by using Gate, and to display banks on Payment Page when choosing a payment method.

The table below provides information on these banks for informational purposes, it may change without additional notice; for the most recent list of supported banks, contact your ECommPay Key Account Manager or POST the /v2/info/banks/netherlands/sale/list request using Gate API. This request belongs to the following request group /v2/info/banks/{payment_method}/{operationType}/list.

The request must contain the project and payment IDs, signature, currency, and payment amount, as shown in the example. It is important to specify real payment data, but if the payment has not yet been generated, you can specify a random value for the payment ID in the request.

Figure: Example of requesting a list of banks

{
  "general": {
    "project_id": 200,
    "payment_id": "ORDER_155860015",
    "signature": "K6jllym+PtObocZtr345st...=="
  },
  "payment": {
    "amount": 1000,
    "currency": "EUR"
  }
}
Table 1. List of banks
Bank ID
Rabobank 2141
ABN AMRO Bank N.V. 2131
ING Group 2121
Van Lanschot NV 2151

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchases by using Payment Page

General information

In the Open Banking in the Netherlands method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ECommPay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can either allow your customer to select the Open Banking in the Netherlands method from the list of other payment methods on Payment Page or have Payment Page opened with the Open Banking in the Netherlands method selected. For more information about preselecting payment methods, see in Preselecting payment method.

Two ways of bank selection are supported: on the Payment Page side and on the provider side.

Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side



Figure: Purchase sequence by using Payment Page with bank selection on the Payment Page side

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects one of the banks from Open Banking in the Netherlands group.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing.
  10. The payment platform sends the customer redirection data to Payment Page.
  11. The customer is redirected to the provider website.
  12. The customer confirms the bank selection.
  13. The customer is redirected to the bank website.
  14. The bank payment form is displayed to the customer.
  15. The customer completes all the required payment steps.
  16. The payment is processed on the bank side.
  17. The result is displayed to the customer on the bank website.
  18. The bank service sends the result notification to the provider service.
  19. The provider service sends the result notification to the payment platform.
  20. The payment platform sends a callback with the payment result to the web service.
  21. The payment platform sends the result to Payment Page.
  22. A page with the payment result information is displayed to the customer on Payment Page.

Figure: Purchase sequence by using Payment Page with bank selection on the provider side



Figure: Purchase sequence by using Payment Page with bank selection on the provider side

  1. A customer initiates a purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the specified ECommPay URL.
  3. The request for opening is redirected to the payment platform.
  4. The payment platform performs the initial request processing that involves validation of the required parameters and signature.
  5. Requested Payment Page is generated into the ECommPay payment platform as specified in the project settings and the request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Open Banking in the Netherlands method.
  8. The payment platform receives the purchase request for payment processing.
  9. The payment platform performs the internal purchase request processing.
  10. The payment platform sends the customer redirection data to Payment Page.
  11. The customer is redirected to the bank selection page.
  12. The customer selects bank for payment.
  13. The customer is redirected to the bank site.
  14. The bank payment form is displayed to the customer.
  15. The customer completes all the payment steps required.
  16. The payment is processed on the bank side.
  17. The result is displayed to the customer on the bank website.
  18. The bank service sends the result notification to the provider service.
  19. The provider service sends the result notification to the payment platform.
  20. The payment platform sends a callback with the payment result to the web service.
  21. The payment platform sends the result to Payment Page.
  22. A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow provide details the request format and the Payment Page parameters to use in the Open Banking in the Netherlands payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you must consider when performing a purchase through the Open Banking in the Netherlands method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
    • project_id—the project ID obtained from ECommPay
    • payment_id—payment ID unique within the project
    • payment_currency—payment currency in ISO-4217 alpha-3 format
    • payment_amount—purchase amount in minor currency units
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be EUR.
  3. You can customise the selecting payment method page on Payment Page.

    By default, banks that support Open Banking in the Netherlands payment method are grouped in one button on Payment Page, so the selection of a bank is carried out in two steps.

    Purchase by using Payment Page with bank selection on the provider side

    When performing purchases by using Payment Page with bank selection on the provider side, first, customer chooses the Open Banking in the Netherlands method on the Payment Page, and then customer is redirected to the bank selection page for final bank selection. In that case it is possible to display Payment Page with preselected payment method. For that, pass the netherlands code in the force_payment_method parameter.

    Purchase by using Payment Page with bank selection on the Payment Page side

    When performing purchases by using Payment Page with bank selection on the Payment Page side, first, the Open Banking in the Netherlands method is chosen among others, and then a particular bank is selected on the next page with the list of the group banks. There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display each bank of the Open Banking in the Netherlands group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.
      payment_methods_options={"netherlands": {"split_banks": true}}
      
    • To display a button of a specific bank (one or several) from Open Banking in the Netherlands group on Payment Page in the list of payment methods, pass the bank identifier in the banks_id parameter. If it is necessary to display several banks from a group, pass the identifiers of these banks separated by a comma with a space.
      payment_methods_options={"netherlands": {"split_banks": true, "banks_id": [2141, 2131]}}
    • To preselect Open Banking in the Netherlands as the payment method on Payment Page for customers, pass the code netherlands in the force_payment_method parameter in the request for opening. The list of the banks from Open Banking in the Netherlands group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To redirect the customer to the provider where one of the banks from the Open Banking in the Netherlands group is preselected, pass the code netherlands in the force_payment_method parameter and the bank identifier banks_id in the payment_methods_options string. The customer is redirected to the bank website without confirming willingness to pay, bypassing the pages with the payment method selection and the choice of banks on Payment Page.

      Figure: Example of the purchase request with displaying a preselected bank on the provider side

          {
            payment_id: 'X03936', 
            payment_amount: 1000, 
            payment_currency: 'EUR', 
            project_id: 123,
            customer_id: 'customer1',
            force_payment_method: 'netherlands',
            payment_methods_options={"netherlands": {"banks_id": [2131]}},
            signature: "kUi2x9dKHAVNU0FYlSCQ9vySO\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
          }
  4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the Open Banking in the Netherlands method, see Payment Page invocation parameters.
  5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Open Banking in the Netherlands method must include project, customer and payment IDs, the currency and the amount of a payment and signature, as shown in the following example:

    {
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR', 
      project_id: 123,
      customer_id: 'customer1',
      signature: "kUi2x9dKHAVNU0FYldJrxh4...zUCwX6R\/ekpZhkIQg=="
    }

Callback format

The standard format for callbacks is used to deliver purchase results from Open Banking in the Netherlands. For more information, see Callbacks.

Here is the example of a callback with an information about successful 10,00 EUR purchase made in the 200 project.

Figure: Example of a succeed purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714117",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "method": "Netherlands Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Success"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065607,
            "type": "sale",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009530",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ=="
    }

Here is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714118",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "method": "Netherlands Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Decline"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065608,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009531",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ=="
    }

Related topics

The following topics might be useful when implementing payments through Payment Page:

Purchases by using Gate

General information

In the Open Banking in the Netherlands method, when processing a purchase by using Gate, the merchant web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ECommPay URL.
  2. Redirect the customer to the website of the provider which supports payment processing by using the Open Banking in the Netherlands method.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase sequence by using Gate with bank selection on the web service side



Figure: Purchase sequence by using Gate with bank selection on the web service side

  1. A customer initiates a purchase through one of the Open Banking in the Netherlands group banks on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform sends the callback with the redirection data to the web service.
  7. The customer is redirected from the web service to the provider website.
  8. The customer confirms the bank selection.
  9. The customer is redirected to the bank website.
  10. The bank payment form is displayed to the customer.
  11. The customer completes all the payment steps required on the bank website.
  12. The payment is processed on the bank side.
  13. The result is displayed to the customer on the bank website.
  14. The bank service sends the payment result notification to the provider service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

Figure: Purchase sequence by using Gate with bank selection on the web service side



Figure: Purchase sequence by using Gate with bank selection on the web service side

  1. A customer initiates a purchase through the provider service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform sends the callback with the redirection data to the web service.
  7. The customer is redirected to the bank selection page.
  8. The customer selects bank for payment.
  9. The customer is redirected to the bank site.
  10. The bank payment form is displayed to the customer.
  11. The customer completes all the required payment steps.
  12. The payment is processed on the bank side.
  13. The result is displayed to the customer on the bank website.
  14. The bank service sends the payment result notification to the provider service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Open Banking in the Netherlands payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

There are several things you must consider when using purchase requests in the Open Banking in the Netherlands method:
  1. You perform purchase by sending the /v2/payment/banks/netherlands/sale request by using POST (HTTP) method. This is an online banking request group: /v2/payment/banks/{payment_method}/sale
  2. The following objects and parameters must be specified in the request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • payment_id—payment ID unique within the project
      • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
    • Object payment—purchase information:
      • amount—purchase amount in minor currency units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—identifier unique within the project
      • ip_address—customer IP address
    • Object account—customer account information:
      • bank_id—bank identifier; the parameter is not mandatory when the bank is selected on the provider website
    • Object return_url—URLs for redirecting a customer from the bank website:
      • return—URL for redirecting a customer during any step of the purchase by pressing a button
  3. The currency of a purchase can only be EUR.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Open Banking in the Netherlands method must include project, payment, customer, and bank IDs, customer IP-address, signature, currency and amount of the purchase, and URL for redirection, as shown in the following example:

Figure: Purchase request example

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
      },
    "customer": {
      "id": "customer123",
      "ip_address": "1.2.3.4"
    },
    "account":{
      "bank_id": 140
    },
    "return_url":{
      "return": "http://example.com/return"
 }
}

Formats of the customer redirection data

In the Open Banking in the Netherlands method, to redirect a customer to the provider website, it is required to do the following:

  1. Receive the callback from the payment platform which includes the redirect_data object. This object contains the object body with the data necessary to reference the provider's JavaScript library and call the function that redirects the customer to the provider website.
  2. Reference provider's JavaScript library using the URL received in the widget_url parameter of the body object.
  3. Call the function that redirects the customer to the provider website using the parameters received in the body object (according to the provider requirements).

The body object contains the following mandatory parameters:

  • widget_url—URL of provider's JavaScript library
  • widget_host—hostname of the provider server
  • token—token which is used in data.token in the function that redirects the customer
  • other—determines the possibility of payment by using banks that are not supported by default on the provider side; this option is not supported in this technical implementation, the value of the parameter is always off
  • callback_url—URL for customer redirection to the web service side after successful payment

The body object can also contain the following optional parameters:

  • creditor—bank identifier code (BIC); the parameter is used when the bank is selected on the web service side
  • css—link to the CSS file with styles which allows the merchant to alter the appearance of the provider website
  • default_country—country code in the ISO 3166-1 alpha-2 format; supported banks of this country are displayed by default on the provider website after customer redirection

Figure: Example of customer redirection data

  "redirect_data": {
    "url": "http://pay.test/example",
        "method": "POST",
    "body": {
      "widget_url":"https://psd2.neopay.lt/widget.js",
      "widget_host":"https://psd2.neopay.lt/",
            "token": "eyJhbGciOiJIUzI1NiIsInR5cCIp0cnVlLCJpYXQiOjE0OTMyMD",
            "other": "off",
            "creditor": "INGBNL2S",
            "css": "https://css.test.org",
            "default_country": "NL",
            "callback_url": "https://callback.url.org"
    }
  }

The following is the example of the URL which is used to reference the provider's JavaScript library and the example of call of the function which redirects the customer the provider website. Both of these examples are based on the example of customer redirection data provider above.

Figure: Example of URL of provider's JavaScript library

<script type="text/javascript" src="https://psd2.neopay.lt/widget.js"></script> 

Figure: Example of call of the function which redirects the customer to the provider website

var NEOWidgetHost = "https://psd2.neopay.lt";
NEOWidget.initialize(
    NEOWidgetHost,
    data.token,
    {
    'other':'off',
    'creditor': 'INGBNL2S',
    'css':'https://css.test.org',
    'default_country':'NL',
    'callback_url':'https://callback.url.org'
    }
); 

Callback format

In the Open Banking in the Netherlands method, the callbacks that deliver purchase results use the standard format described in Callbacks.

The following is the example of a callback with the information about successful 10.00 EUR purchase made in the 200 project.

Figure: Example of a succeed purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714117",
            "type": "purchase",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "method": "Netherlands Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Success"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065607,
            "type": "sale",
            "status": "success",
            "date": "2020-03-20T14:22:06+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009530",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivMlmbhQ=="
    }

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
        "project_id": 200,
        "payment": {
            "id": "E2E_deploy_S05_0.04896200_1584714118",
            "type": "purchase",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "method": "Netherlands Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "Decline"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 9529253065608,
            "type": "sale",
            "status": "decline",
            "date": "2020-03-20T14:22:07+0000",
            "created_date": "2020-03-20T14:22:00+0000",
            "request_id": "f1de353331a01fd14163fe4226-00009531",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 1914,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "giRT+RB/rG5JrSMjb/...DaHDxz+JukI2+7HhMivM2mbhQ=="
    }

Related topics

The following topics might be useful when implementing payments through Gate:

Analysis of payments results

As with other payment methods ECommPay offers, when using the Open Banking in the Netherlands method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

  • Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
  • Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ECommPay technical support.