Open Banking in Portugal

Overview

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

General information

Payment method type online banking
Countries and regions PT
Payment currencies EUR
Currency conversion on the ECommPay side
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations it is possible to specify additional parameters when sending a request for processing the purchase by using Payment Page
Obtaining access to the payment method and access fee refer to your ECommPay key account manager

Interaction diagram

Payment processing by using the Open Banking in Portugal 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 Times**
Payment Page CMS Plug-ins Gate Dashboard (Old Dashboard) minimum maximum basic threshold
Purchases + + * * * *

* Amount limits and payment processing times depend on banks.

** The basic and threshold times are defined as follows:

  • The basic time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the initiator. The basic time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
  • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ECommPay technical support.

Processing scenarios

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

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Supported banks

Payments through the Open Banking in Portugal 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/portugal/sale/list request using Gate API. This request belongs to the following request group /v2/info/banks/{payment_method}/{operationType}/list.

Table 1. List of banks
Bank ID
   
Banco Activobank 6651
Millennium bcp 6641
Novo Banco Dos Acores 6631
Novo Banco 6621
Banco Santander Totta 6331
Banco BPI 6661

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.

Purchase by using Payment Page

General information

In the Open Banking in Portugal 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 Portugal method from the list of other payment methods on Payment Page or have Payment Page opened with the Open Banking in Portugal method selected. For more information about preselecting payment methods, see in Preselecting payment methods.



Figure: Purchase by using Payment Page

  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 Portugal 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.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Open Banking in Portugal 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 need to consider when using the Open Banking in Portugal 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. It is recommended to specify the first and last names of the customer in the customer_first_name and customer_last_name additional parameters. If the request is missing the parameters, on Payment Page the additional fields are displayed to the customer to input missing data. For more details, see Submission of additional payment information.
  3. You can customise the selecting payment method page on Payment Page.

    By default, the banks are grouped in one Portuguese banks button on Payment Page, so the selection of a bank is carried out in two steps. First, the Open Banking in Portugal method is chosen among others, and then the bank is selected on the next page with the list of the banks.

    There are several options for displaying the page with the selecting of payment method on Payment Page:

    • To display banks grouped in one Portuguese banks button on Payment Page in the list of payment methods.
    • To display only one Portuguese banks button without other payment methods. To preselect Open Banking in Portugal as the payment method on Payment Page, pass the code online-portuguese-banks in the force_payment_method parameter. The list of the banks from Open Banking in Portugal group with separate buttons are displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To display the banks with separate buttons in the list of payment methods. You need to pass true in the split_banks parameter in the request for opening in the payment_methods_options string.
      payment_methods_options={"portugal": {"split_banks": true}}
      
    • To display a button of a specific bank (one or several) from Open Banking in Portugal 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={"portugal": {"split_banks": true, "banks_id": [6651, 6641]}}

      Here is the example of a request for opening Payment Page with preselected payment method and a bank.

      Figure: Example of the request with preselecting the payment method and a bank

          { 
            payment_id: '580', 
            payment_amount: 1000, 
            payment_currency: 'EUR', 
            project_id: 120,
            force_payment_method: 'online-portuguese-banks',
            payment_methods_options={"portugal": {"banks_id": [6651]}},
            customer_id: 'customer1',
            customer_first_name: 'John',
            customer_last_name: 'Doe',
            signature: "XFyr/D1zXj84lUZVfpbWZol9JAZLnUZoPJKPXRbOqBUpxxa/hOKm2
                                  P8XOqydoyeIi7KdqrcxLFd3GxgPgUzIDg==
          }
  4. If required, you can also add any other additional parameters Payment Page supports.
  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 Portugal method must include project, customer, and payment IDs, the currency and the amount of a payment, the first and last name of the customer, as shown in the following example:

    { 
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'EUR', 
      project_id: 123, 
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Doe',
      signature: "kUi2x9dKHA...\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the Open Banking in Portugal method, see Payment Page invocation parameters.

Callback format

The Open Banking in Portugal method uses the standard format for callbacks to deliver purchase results. 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 successful purchase callback

 {
        "project_id": 239,
        "payment": {
            "id": "TEST_PAYMENT_671446",
            "type": "purchase",
            "status": "success",
            "date": "2020-11-03T14:41:38+0000",
            "method": "Portuguese Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "TEST_PAYMENT_671446"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 77796010023511,
            "type": "sale",
            "status": "success",
            "date": "2020-11-03T14:41:38+0000",
            "created_date": "2020-11-03T14:39:34+0000",
            "request_id": "4727897a23d96203f784...d22c87a7f4f473d93-00077797",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3901,
                "payment_id": "t:5nFu358iuKC3vz8g...zQLtgSSoyAQubVf",
                "auth_code": ""
            }
        },
        "signature": "8UuSBBDvR9RlVXJR+3A3JeYOOPhf...1VlLygAOq+NPNKLu37IZ0kw=="
    }

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

Figure: Example of a declined purchase callback

 {
        "customer": {
            "id": "1"
        },
        "project_id": 10801,
        "payment": {
            "id": "TEST_PAYMENT_624318",
            "type": "purchase",
            "status": "decline",
            "date": "2020-11-03T15:47:39+0000",
            "method": "Portuguese Banks",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_PAYMENT_624318"
        },
        "operation": {
            "id": 92939010024021,
            "type": "sale",
            "status": "decline",
            "date": "2020-11-03T15:47:39+0000",
            "created_date": "2020-11-03T15:47:02+0000",
            "request_id": "2973231f346e408fcf62f1e3388a...3971c8ccb13-00092940",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3901,
                "payment_id": ""
            }
        },
        "signature": "GK7q/MHaYQuUqSQiCzWFi.../6UzJhblNPSr7tj1/PWfWgCJLbnaeg=="
    }

Related topics

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

Purchase by using Gate

General information

In the Open Banking in Portugal 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 Portugal 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 by using Gate

  1. A customer initiates a purchase through one of the Open Banking in Portugal 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Open Banking in Portugal payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Open Banking in Portugal method:
  1. You perform purchase by sending the /v2/payment/banks/portugal/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—the unique ID of the customer within your project
      • ip_address—customer IP address
    • Object account—customer account information:
      • bank_id—bank identifier
    • Object return_url—URLs for redirecting a customer from the bank website:
      • return—URL for redirecting a customer during any step of the purchase
  3. It is recommended to specify the additional parameters. If the request is missing the parameters, the list of parameters is sent in the clarification callback. For more details, see Submission of additional payment information.

    There is the list of recommended objects and parameters:

    • Object customer—customer information:
      • first_name—first name
      • last_name—last name
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a purchase request

{
    "general": {
      "project_id": 2990,
      "payment_id": payment_id,
      "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
      },
    "customer": {
      "id": "customer1",
      "ip_address": "66.249.64.45",
      "first_name": "John",
      "last_name": "Doe"
    },
    "account":{
      "bank_id": 6651
    },
    "return_url":{
      "return": "http://example.com/return"
 }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Open Banking in Portugal site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

"redirect": {
        "method": "POST",
        "encrypted": [],
        "url": "https://web-app.example.com/app/request-token/rq:3R123"
    }

Callback format

The Open Banking in Portugal method uses the standard format for callbacks to deliver purchase results. For more information, see 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 successful purchase callback

 {
        "project_id": 239,
        "payment": {
            "id": "TEST_PAYMENT_671446",
            "type": "purchase",
            "status": "success",
            "date": "2020-11-03T14:41:38+0000",
            "method": "Portuguese Banks",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": "TEST_PAYMENT_671446"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 77796010023511,
            "type": "sale",
            "status": "success",
            "date": "2020-11-03T14:41:38+0000",
            "created_date": "2020-11-03T14:39:34+0000",
            "request_id": "4727897a23d96203f784...d22c87a7f4f473d93-00077797",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 3901,
                "payment_id": "t:5nFu358iuKC3vz8g...zQLtgSSoyAQubVf",
                "auth_code": ""
            }
        },
        "signature": "8UuSBBDvR9RlVXJR+3A3JeYOOPhf...1VlLygAOq+NPNKLu37IZ0kw=="
    }

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

Figure: Example of a declined purchase callback

 {
        "customer": {
            "id": "1"
        },
        "project_id": 10801,
        "payment": {
            "id": "TEST_PAYMENT_624318",
            "type": "purchase",
            "status": "decline",
            "date": "2020-11-03T15:47:39+0000",
            "method": "Portuguese Banks",
            "sum": {
                "amount": 100,
                "currency": "EUR"
            },
            "description": "TEST_PAYMENT_624318"
        },
        "operation": {
            "id": 92939010024021,
            "type": "sale",
            "status": "decline",
            "date": "2020-11-03T15:47:39+0000",
            "created_date": "2020-11-03T15:47:02+0000",
            "request_id": "2973231f346e408fcf62f1e3388a...3971c8ccb13-00092940",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 3901,
                "payment_id": ""
            }
        },
        "signature": "GK7q/MHaYQuUqSQiCzWFi.../6UzJhblNPSr7tj1/PWfWgCJLbnaeg=="
    }

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 Portugal 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.