Open Banking in the UK

Overview

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

General information

Payment method type online banking
Countries and regions GB
Payment currencies GBP
Currency conversion
Purchases +
Payouts
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations
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 the UK payment method requires merchant's web service, one of ECommPay interfaces, and the ECommPay payment platform, as well as technical facilities of supported banks.



Operations support

  Interfaces Amounts, GBP Times**
Payment Page CMS Plug-ins Gate 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 the UK method to perform a purchase operation, you need to redirect customer to the bank service.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



Supported banks

Payments through the Open Banking in the UK method are carried out through banks that are supported by 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/uk/sale/list request using Gate API: /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": "GBP"
  }
}
Table 1. List of banks
Bank ID
Adam&Company Bank 3481
Allied Irish Bank 3491
Allied Irish Bank Business 3501
Bank Of Ireland 3511
Bank of Scotland 3521
Barclaycard 3531
Barclays 3541
Cashplus 3801
Chelsea Building Society 3811
Coutts 3551
Creation 3821
Cumberland 3561
Cynergy Bank 3831
Danske 3571
Danske Business 3581
First Direct 3591
First Trust Bank 3601
First Trust Bank Business 3611
Halifax 3621
HSBC 3631
HSBC Business 3641
Kleinwort Hambros 3651
Lloyds 3661
Marks & Spencer 3671
MBNA 3841
Mettle 3681
Mizuho 3691
Monzo 3851
Nationwide 3701
NatWest 3711
Revolut 3731
Royal Bank of Scotland 3721
Sainsbury's Bank 3861
Santander 3741
Starling 3871
Tesco 3751
Ulster Bank 3761
Ulster Bank Republic Of Ireland 3771
Vanquis 3781
Yorkshire Building Society 3791

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 UK method, when processing 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 have Payment Page opened with the Open Banking in the UK method selected. For more information about preselecting payment methods, see in Preselecting payment method. The full sequence and particularities of the purchase process are provided below.



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 the Open Banking in the UK method and selects one of the supported banks.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and sends it to the bank service.
  10. The purchase request is processed on the bank service side.
  11. The bank service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the bank service.
  14. The customer completes all the required payment steps.
  15. The payment is processed on the bank service side.
  16. The customer is redirected to Payment Page.
  17. The Open Banking in the UK service sends the result notification to the payment platform.
  18. The payment platform sends a callback with the payment result to the web service.
  19. The payment platform sends the result to Payment Page.
  20. 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 the UK 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 the UK 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—payment amount in minor units
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be GBP.
  3. You can customise the selecting payment method page on Payment Page.

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

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

    • To display grouped in one UK Online banking button on Payment Page in the list of payment methods.
    • To preselect Open Banking in the UK as the payment method on Payment Page for customers, pass the code uk in the force_payment_method parameter in the request. The list of the banks from Open Banking in the UK group is displayed to a customer on Payment Page bypassing the page with the payment method selection.
    • To display each bank of the Open Banking in the UK group with a separate buttons, pass split_banks=true in the request for opening in the payment_methods_options string.
      payment_methods_options={"uk": {"split_banks": true}}
      
    • To display a button of a specific bank (one or several) from Open Banking in the UK 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={"uk": {"split_banks": true, "banks_id": [3761, 3771]}}

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

      Figure: Example of the request for with preselected payment method and bank

          { payment_id: 'X03936', 
            payment_amount: 1000, 
            payment_currency: 'GBP', 
            project_id: 120,
            customer_id: 'customer1',
            force_payment_method: 'uk',
            payment_methods_options={"uk": {"banks_id": [3771]}},
            signature: "kUi2x9dKHAVNU0FYlSCQ9vySO\/...tVUkDR\/ekpZhkIQg=="
          }
  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 the UK method must include project, customer and payment IDs, the currency and the amount of a payment, as well as signature, as shown in the following example:

    { 
      payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'GBP', 
      project_id: 123, 
      customer_id: 'customer1',
      signature: "kUi2x9dKHA...\/RLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

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

Callback format

The Open Banking in the UK 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 an information about successful 10.00 GBP purchase made in the 239 project.

Figure: Example of a successful purchase callback

{
   "project_id":239,
   "payment":{
      "id":"ID_461239",
      "type":"purchase",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "method":"UK banks",
      "sum":{
         "amount":1000,
         "currency":"GBP"
      },
      "description":"ID_461239"
   },
   "customer":{
      "id":"1"
   },
   "operation":{
      "id":59043000050811,
      "type":"sale",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "created_date":"2020-06-15T14:51:35+0000",
      "request_id":"929c6911448765aedaf4df...79aa8d4adb6b78dc5-00059044",
      "sum_initial":{
         "amount":1000,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":1000,
         "currency":"GBP"
      },
      "code":"0",
      "message":"Success",
      "provider":{
         "id":2901,
         "payment_id":"385dc36c-7fac-4bf5-a0e6-6a16ebcc1962",
         "auth_code":"",
         "endpoint_id":"Halifax",
         "date":"2020-06-15T14:51:36+0000"
      }
   },
   "signature":"+KDWbziHMNDBSd2Y04Cc...xRb55AnjtvrZc4XgG6iXkJyLHPa3ZbYw=="
}

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":"ID_542650",
      "type":"purchase",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "method":"UK banks",
      "sum":{
         "amount":100,
         "currency":"GBP"
      },
      "description":"ID_542650"
   },
   "operation":{
      "id":58778000050861,
      "type":"sale",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "created_date":"2020-06-15T11:36:39+0000",
      "request_id":"e6cb17dd0699001b813a0...6753e4dca478c7eb6-00058779",
      "sum_initial":{
         "amount":100,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":100,
         "currency":"GBP"
      },
      "code":"20000",
      "message":"General decline",
      "provider":{
         "id":2901,
         "payment_id":"BARCLAYS-P-10000000420474",
         "auth_code":"",
         "endpoint_id":"Barclays",
         "date":"2020-06-15T11:36:41+0000"
      }
   },
   "signature":"kC6wuur3Q2Dswd7A6R+C...1EaupyvFHs6q/aZ7lW17cUuFhXjHoVWbrTJqQ=="
}

Related topics

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

Purchases by using Gate

General information

In the Open Banking in the UK 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. Perform the redirection of a customer to the bank service.
  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 Open Banking in the UK 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 performs the internal payment request processing and redirects the request to the bank service.
  7. The request is processed on the bank service side.
  8. The bank service sends the data for redirecting the customer to the bank service to the payment platform.
  9. The payment platform sends the callback with the redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the bank service.
  11. The customer completes all the required payment steps.
  12. The payment is processed on the bank service side.
  13. The customer is redirected to the merchant's web service.
  14. The bank service sends the payment result notification to the payment platform.
  15. The payment platform sends a callback to the web service.
  16. 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 UK 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 the UK method:
  1. You send purchase requests by sending the /v2/payment/banks/uk/sale request by using the POST HTTP method. The request belongs to the following request group: /v2/payment/banks/{payment_method}/sale.
  2. The following objects and parameters must be specified in any 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—payment information:
      • amount—purchase amount in minor units
      • currency—purchase currency in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—unique ID of the customer within the project
      • ip_address—customer IP address
    • Object account—customer account information:
      • bank_id—bank identifier
    • Object return_url—contains the URL to which customer is redirected while or after payment processing:
      • return—URL to return customer to the web service during any step before the payment is completed.
  3. The currency of purchase can only be GBP.
  4. If required, you can also add any other additional parameters Gate supports.

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

Figure: Example of a purchase request

  "general": {
    "project_id": 1111,
    "payment_id":"Test-sale-001",
    "signature": "52D7C03EA096CAB4F27...EC4280509D293D1094AA793BBC"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "1.2.3.4"
  },
  "account": {
    "bank_id": 3791
  },
  "payment": {
    "amount": 1000,
    "currency": "GBP"
  },
  "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 the UK site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and use this URL for opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the token for purchase.

  "redirect_data": {
    "method": "GET",
    "url": "http://redirect.bank.exmaple.com"
  }

Callback format

The Open Banking in the UK 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 an information about successful 10.00 GBP purchase made in the 239 project.

Figure: Example of a successful purchase callback

{
   "project_id":239,
   "payment":{
      "id":"ID_461239",
      "type":"purchase",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "method":"UK banks",
      "sum":{
         "amount":1000,
         "currency":"GBP"
      },
      "description":"ID_461239"
   },
   "customer":{
      "id":"1"
   },
   "operation":{
      "id":59043000050811,
      "type":"sale",
      "status":"success",
      "date":"2020-06-15T14:55:23+0000",
      "created_date":"2020-06-15T14:51:35+0000",
      "request_id":"929c6911448765aedaf4df...79aa8d4adb6b78dc5-00059044",
      "sum_initial":{
         "amount":1000,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":1000,
         "currency":"GBP"
      },
      "code":"0",
      "message":"Success",
      "provider":{
         "id":2901,
         "payment_id":"385dc36c-7fac-4bf5-a0e6-6a16ebcc1962",
         "auth_code":"",
         "endpoint_id":"Halifax",
         "date":"2020-06-15T14:51:36+0000"
      }
   },
   "signature":"+KDWbziHMNDBSd2Y04Cc...xRb55AnjtvrZc4XgG6iXkJyLHPa3ZbYw=="
}

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":"ID_542650",
      "type":"purchase",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "method":"UK banks",
      "sum":{
         "amount":100,
         "currency":"GBP"
      },
      "description":"ID_542650"
   },
   "operation":{
      "id":58778000050861,
      "type":"sale",
      "status":"decline",
      "date":"2020-06-15T11:46:42+0000",
      "created_date":"2020-06-15T11:36:39+0000",
      "request_id":"e6cb17dd0699001b813a0...6753e4dca478c7eb6-00058779",
      "sum_initial":{
         "amount":100,
         "currency":"GBP"
      },
      "sum_converted":{
         "amount":100,
         "currency":"GBP"
      },
      "code":"20000",
      "message":"General decline",
      "provider":{
         "id":2901,
         "payment_id":"BARCLAYS-P-10000000420474",
         "auth_code":"",
         "endpoint_id":"Barclays",
         "date":"2020-06-15T11:36:41+0000"
      }
   },
   "signature":"kC6wuur3Q2Dswd7A6R+C...1EaupyvFHs6q/aZ7lW17cUuFhXjHoVWbrTJqQ=="
}

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