GB OPEN BANKING

Overview:
GBP payments settle over UK open banking. The payer authorises the payment in their own banking app and funds move account-to-account, with no card details and no stored credentials.

Pay-in only. UK open banking has no payout surface.

Payment flow

Open banking is a redirect flow rather than a direct debit, so a payment takes three hops:

1. Call Initiate APM payment. The response carries data.payment_url.
2. Redirect the payer to that URL. They pick their bank from the list shown.
3. They authorise in their own bank, then return to your callback_url.

The payer chooses their own bank, so unlike a payout you never send a bank code.

A payment session stays open for 60 minutes from creation. After that the payer has to start a new payment.

Payin

Payin request body:

Field	Type	Requirement Level	Description
amount	number	Required	Amount in GBP. Minimum 0.01
currency	string	Required	"GBP". UK open banking supports GBP only
method_code	string	Required	"GB_OPEN_BANKING"
customer	object	Required	Customer object
customer.country	string	Required	Customer's country (iso2)
customer.email	string	Optional	Customer's email address
customer.first_name	string	Optional	Customer's first name
customer.last_name	string	Optional	Customer's last name
reference	string	Optional	Merchant reference
description	string	Optional	Description for this payment. Truncated to 1000 characters
callback_url	string	Optional	HTTPS URL the payer returns to after authorising at their bank
webhook_url	string	Optional	HTTPS URL for payment notifications
metadata	object	Optional	Merchant metadata, returned in notifications

Sample Payload:

JSON

{
  "amount": 100.00,
  "currency": "GBP",
  "method_code": "GB_OPEN_BANKING",
  "reference": "INV-2025-001",
  "description": "Order INV-2025-001",
  "metadata": {
    "internal_id": "user1234"
  },
  "webhook_url": "https://yourwebsite.com/webhook",
  "callback_url": "https://yourwebsite.com/callback",
  "customer": {
    "first_name": "Firstname",
    "last_name": "Lastname",
    "email": "[email protected]",
    "country": "GB"
  }
}

Payout

Not supported. UK open banking is available for pay-ins only.