Online banking in the United Kingdom

Online banking in the United Kingdom is processed through direct payment requests.

Parameter	Type	Required	Description
pos_id	UUID	✅	Merchant's identifier (POS_ID)
mode	MODE	✅	direct
method	METHOD	✅	Payment method (purchase)
amount	Number	✅	Transaction amount. Must be a positive number
currency	CURRENCY	✅	Transaction currency (ISO_4217)
order_3ds_bypass	String	✅	3-D Secure flow option
order_id	String	✅	Unique identifier of order
description	String	✅	Payment description
payway	String	✅	banking
customer_fname	String	✅	Customer's first name
customer_lname	String	✅	Customer's last name
customer_email	String	✅	Customer's email
customer_phone	String	✅	Customer's phone
customer_birthday	String	✅	Customer's birthday (format: yyyy-MM-dd)
properties.instrument_type	String	✅	Instrument type (online_banking)
properties.instrument_method	String	✅	Instrument method alias (BANK_GBP)
server_url	URL		Webhook notification will be sent to this URL
result_url	URL		Customer will be redirected to this URL after payment

info

Passing parameters in properties.instrument_method

The BANK_GBP value opens the checkout with all available banks. To show a specific bank right away, pass one of the following aliases: BANK_REVOLUT, BANK_MONZO, BANK_LLOYDS, BANK_HALIFAX, BANK_HSBCBANK, BANK_BARCLAYS.

Request example:

{
  "pos_id": "00000000-0000-0000-0000-000000000000",
  "mode": "direct",
  "amount": 1,
  "method": "purchase",
  "currency": "GBP",
  "payway": "banking",
  "customer_phone": "0605556677",
  "customer_birthday": "1990-01-01",
  "customer_email": "mail@mail.net",
  "customer_fname": "Name",
  "customer_lname": "second name",
  "properties": {
    "instrument_type": "online_banking",
    "instrument_method": "BANK_GBP"
  },
  "order_3ds_bypass": "supported",
  "description": "Test description",
  "order_id": "1234567890",
  "server_url": "http://callback-stub:9000/consume",
  "result_url": "https://google.com"
}