PISP API Overview

Base URL

The base URL for all AIS APIs is: https://rs1.bobapi.co.uk/open-banking/v3.1/pisp/**

Supported Payment Types

The Bank of Beirut (UK) Ltd API currently supports:

• Domestic Payments
• International payments

Overview

The following apply to all domestic payment consents:

InstructedAmount/Amount

• There is no MAX InstructedAmount/Amount mandated by Bank of Beirut (UK) Ltd API.
• Bank of Beirut (UK) Ltd applies a GBP 50,000 per day aggregate limit.Bank of Beirut (UK) Ltd suggest PISP notify the PSU that the same limits apply as in their Bank of Beirut (UK) Ltd app. It is possible from time to time that domestic-payment-consents is authorised, but the payment initiation fails due to account limits.

InstructedAmount/Currency

• InstructedAmount/Currency must be GBP

RemittanceInformation/Reference

RemittanceInformation/Reference is a mandatory field and must adhere to the following:

• Valid characters:
  • A-Z
  • a-z
  • 0-9
  • "space"
  • The characters "&", "-", ".", "/"
• Contiguous characters – user enters 6 or more valid characters but without contiguous string of at least 6 alphanumeric characters
• Must contain a contiguous string of at least 6 alphanumeric characters
• Homogeneous string – user enters 6 or more valid characters (including valid non-alphanumeric characters) - After stripping out non-alphanumeric characters the resulting string cannot consist of all the same character

The PISP may also opt to populate reference field on behalf of the PSU

LocalInstrument

The only LocalInstrument supported is faster payment scheme. This field, if specified, must have the value UK.OBIE.FPS. If anything other than this is sent by PISP in consent payload then an error will be returned.

However, this field is not mandatory so we suggest PISP simply not include this field and Bank of Beirut (UK) Ltd will stage consent as a faster payment.

Account.SchemeName

The only supported Account.SchemeName is UK.OBIE.SortCodeAccountNumber for both DebtorAccount and CreditorAccount. Any other enum provided will return error.