Bank of London API
The Bank of London's public REST banking API (v2/v3 path-versioned), published as OpenAPI 3.0.3 from the Developer Studio. 58 operations across ten tags — Accounts, Customer Management, Virtual Account Management, Confirmation of Payee, Payments V2 (internal, Faster Payments, Bacs, CHAPS, agency and FX/cross-border), Standing Orders, Transactions, Mandates (Direct Debits), Statements and Webhook Management. Requests are authenticated with a per-request detached JWS (PS256) in the `x-jws-signature` header, signed with an API key created in the Developer Studio; payments and standing orders carry a client-supplied `idempotencyId`.
This API exposes 58 operations across 42 paths, organized into 10 resource areas, and defines 369 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.
Requests are made against 3 base URLs: https://sandbox-api.bankoflondon.com/, https://api.bankoflondon.com/, https://developer.bankoflondon.com/api/mock/the-bank-of-london-api.
58 operations
42 paths
369 schemas
1 DELETE26 GET7 PATCH24 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 58
Across 42 paths, the API surfaces 58 operations — 1 DELETE, 26 GET, 7 PATCH, 24 POST. They span 10 resource areas: Accounts, Customer Management, Virtual Account Management, Confirmation of Payee, Payments V2, Standing Orders, Transactions, Mandates (Direct Debits), Statements, Webhook Management. Each is listed below with its method, path, parameters, and response codes.
Accounts 5
POST
/v2/accounts
Create Account
GET
/v2/accounts
Get Accounts
GET
/v2/accounts/{id}
Get Account
PATCH
/v2/accounts/{id}
Update Account
POST
/v2/accounts/{id}/close
Close Account
Customer Management 8
POST
/v2/individuals
Create Individual
GET
/v2/individuals
Get Individuals
GET
/v2/individuals/{id}
Get Individual
PATCH
/v2/individuals/{id}
Update Individual
POST
/v3/organisations
Create Organisation v3
GET
/v3/organisations
Get Organisations v3
GET
/v3/organisations/{id}
Get Organisation v3
PATCH
/v3/organisations/{id}
Update Organisation v3
Virtual Account Management 12
GET
/v2/virtual/accounts
Get Virtual Accounts
POST
/v2/virtual/accounts
Create a Virtual Account
GET
/v2/virtual/accounts/{id}
Get a Virtual Account
PATCH
/v2/virtual/accounts/{id}
Update a Virtual Account
POST
/v2/virtual/accounts/{id}/close
Close Virtual Account
GET
/v3/virtual/transactions
Get Virtual Account Transactions V3
GET
/v2/virtual/aggregator-nodes
Get Virtual Aggregator Nodes
POST
/v2/virtual/aggregator-nodes
Create a Virtual Aggregator Node
GET
/v2/virtual/aggregator-nodes/{id}
Get a Virtual Aggregator Node
PATCH
/v2/virtual/aggregator-nodes/{id}
Update a Virtual Aggregator Node
GET
/v2/virtual/hierarchy
Get a Hierarchy
POST
/v2/virtual/hierarchy
Create a Virtual Account Hierarchy
Confirmation of Payee 1
POST
/v2/confirmation-of-payee
Confirm Payee
Payments V2 10
POST
/v2/fx-quotes
Create an FX Quote
GET
/v2/fx-quotes/{quoteId}
Get an FX Quote
POST
/v2/payments/internal
Create an Internal Payment
POST
/v2/payments/faster-payment
Create a Faster Payment
POST
/v2/payments/bacs
Create a Bacs Payment
POST
/v2/payments/chaps
Create a CHAPS Payment
POST
/v2/payments/agency
Create an Agency Payment
POST
/v2/payments
Create a Cross-border Payment
GET
/v2/payments
Get Payments
GET
/v2/payments/{paymentId}
Get Payment
Standing Orders 6
POST
/v2/standing-orders/faster-payment
Create a Faster Payment Standing Order
POST
/v2/standing-orders/internal
Create an Internal Standing Order
GET
/v2/standing-orders
Get Standing Orders
GET
/v2/standing-orders/{standingOrderId}
Get Standing Order
PATCH
/v2/standing-orders/{standingOrderId}
Update a Standing Order
POST
/v2/standing-orders/{standingOrderId}/cancel
Cancel a Standing Order
Transactions 5
GET
/v3/transactions
Get Transactions V3
GET
/v3/transactions/{transactionId}
Get Transaction V3
GET
/v3/transaction-export/{transactionExportId}
Get Transaction Export V3
GET
/v3/transaction-export
Get Transaction Exports V3
POST
/v3/transaction-export
Initiate Transaction Export V3
Mandates (Direct Debits) 3
GET
/v2/mandates
Get Mandates
GET
/v2/mandates/{mandateId}
Get Mandate
POST
/v2/mandates/{mandateId}/cancel
Cancel Mandate
Statements 2
GET
/v2/statements
Get Statements
GET
/v2/statements/{statementId}/download
Download Statements
Webhook Management 6
POST
/v2/webhooks
Create Webhook
GET
/v2/webhooks
Get Webhooks
PATCH
/v2/webhooks/{id}
Update Webhook
DELETE
/v2/webhooks/{id}
Delete Webhook
POST
/v2/webhooks/{id}/create-test-event
Create Webhook Test Event
POST
/v2/webhooks/{id}/regenerate-key
Regenerate Webhook Key
Schemas 369
The contract defines 369 schemas that model the data the API accepts and returns. The most detailed are PaymentTransactionV3 (22 properties), PaymentTransactionV31 (22 properties), FPSSinglePayment (19 properties), InternalSinglePayment (19 properties). Each schema is shown below with its type and property counts.
AccountType
string
Attention \ Please note that the allowed values for the type are extensible and new can be added in the future without a major version change. Please ensure th…
AccountOwnership
string
Controls whether to return directly linked or customers' physical accounts, or both. \ DIRECT - returns directly linked physical accounts (DEFAULT). \ INDIRECT…
AccountStatusFilter
string
Supplying the status will return accounts with specific status only.
AccountId
string
Bank of London account ID identifies the account within Bank of London API. This field is considered a unique ID and cannot be constructed using the account nu…
Limits
object
Limits applicable to the account.
1 property
Status
object
An object that represents the status of Bank of London API entity (e.g. payment status, account status etc.)
1 property
1 required
AccountStatus
AccountTotals
object
Totals for an account.
4 properties
4 required
AccountBalances
object
Account balances.
2 properties
1 required
Currency
string
Attention \ Please note that the allowed values for the currency are extensible and new values can be added in the future without a major version change. Pleas…
AccountLockType
string
Attention \ Please note that the allowed values for the lockType are extensible and new values can be added in the future without a major version change. Pleas…
AccountNickname
string
User defined name to identify the account.
InterestDetailUnit
string
The unit of interest.
InterestDetail
object
The unit and value of interest.
2 properties
2 required
InterestData
object
Types of interest and associated properties.
2 properties
AccountCountryCode
string
Attention \ Please note that the allowed values for the countryCode are extensible and new values can be added in the future without a major version change. Pl…
UkAccountNumber
string
In the UK, most bank account numbers consist of eight digits. Some UK banks have shorter account numbers, the number 0 should not be prefixed in those cases. G…
UkSortCode
string
A 6-digit identification number of the bank branch holding the account.
Iban
string
Account identifier in an IBAN format
AccountIdentifiers
object
Identifies the account numbers.
2 properties
2 required
AccountCreatedDateTime
string
The date and time when the account was created.
AccountHolderName
string
Name of the account holder which is issuing or receiving a payment.
NullableAccountOwner
object
Owner of the account. When it is not specified the account will be owned directly by your organisation.
2 properties
2 required
SalesProductId
string
Used to define the interest rate for the account. Note: Sales product IDs are client specific and must be pre-configured. Please contact us at client.partners@…
BaseAccount
object
16 properties
11 required
Account
object
Physical account owned by the requestor or requestors customers
MetaData
object
3 properties
3 required
ErrorResponseDetails
object
A map of additional details about the error. For example, a validation error might include a map of field names to error messages
ErrorResponseJSON
object
5 properties
BadRequestError
UnauthorizedError
ForbiddenError
ValidationError
InternalServerError
PhysicalAccountType
string
Attention \ Please note that the allowed values for the type are extensible and new can be added in the future without a major version change. Please ensure th…
AccountOwner
object
Owner of the account.
2 properties
2 required
CreateAccountRequest
object
Request object that is required to create an account
4 properties
2 required
CreateAccountResponse
object
Create account response object
6 properties
4 required
NotFoundError
Constraints
object
The operational constraints applied to the account. This object is present if the account has constraints applied to it.
1 property
1 required
GetSingleAccountResponse
UpdateAccountRequest
object
Request object that is required to update an account
2 properties
ConflictError
PhysicalAccountClosureReason
string
Attention \ Please note that the allowed values for the type are extensible and new can be added in the future without a major version change. Please ensure th…
AccountIdentifierForAccountClosureUk
object
4 properties
4 required
CloseAccountRequest
object
Request object that is required to close an account
2 properties
2 required
CloseAccountResponse
object
Close account response object
2 properties
2 required
OrganisationId
string
ID of an organisation. When it is not specified, it is then implied that individual is linked to your organisation directly.
PersonId
string
Randomly generated id
PersonNamePrefix
string
Attention \ Please note that the allowed values for the namePrefix are extensible and new values can be added in the future without a major version change. Ple…
PersonFirstName
string
First name
PersonMiddleName
string
Middle name
PersonLastName
string
Last name
Nationality
string
Country in ISO 3166-1 alpha-2 format
DateOfBirth
string
Birthdate in YYYY-MM-DD format
NullablePlaceOfBirth
string
Place of birth
NullableIdentification
object
Individual's identification information.
2 properties
2 required
PersonAddress
object
Individual's address information
5 properties
2 required
NullableEmail
string
Email address
NullablePhoneNumber
string
Phone number
Individual
object
Response object of getting an individual
13 properties
6 required
TooManyRequestsError
PlaceOfBirth
string
Place of birth
NullablePersonFirstName
string
First name
NullablePersonLastName
string
Last name
NullableNationality
string
Country in ISO 3166-1 alpha-2 format
NullableDateOfBirth
string
Birthdate in YYYY-MM-DD format
NullablePersonAddress
object
Individual's address information
5 properties
2 required
OrganisationId1
string
Randomly generated id
OrganisationName
string
Name
CompanyNumber
string
The unique number assigned to the organisation/company when it was founded/incorporated with the authorities - i.e. Companies House in the UK. Note that if let…
FoundationDate
string
The date the organisation/company was founded/incorporated
OrganisationAddress
object
Organisation's address information
5 properties
2 required
OrganisationV2
object
Response object of getting an organisation
5 properties
5 required
NullableOrganisationName
string
Name
NullableCompanyNumber
string
The unique number assigned to the organisation/company when it was founded/incorporated with the authorities - i.e. Companies House in the UK. Note that if let…
NullableFoundationDate
string
The date the organisation/company was founded/incorporated
NullableOrganisationAddress
object
Organisation's address information
5 properties
2 required
NullableClientType
string
Attention \ Please note that the allowed values for the clientType are extensible and new values can be added in the future without a major version change. Ple…
NullableRegulatoryIdentifier
string
Attention \ Please note this field is required property when the clientType is one of the following regulated client types: Regulated client types: \ BANK - A…
OrganisationV3
object
7 properties
4 required
ClientType
string
Attention \ Please note that the allowed values for the clientType are extensible and new values can be added in the future without a major version change. Ple…
AccountOwnership1
string
Supplying the accountOwnership will return Virtual Accounts for specific ownership. \ ALL: all Virtual Accounts directly and indirectly linked to the requestor…
HeaderAccountId
string
The Header Account associated with the Virtual Account.
VirtualAccountAggregatorNodeId
string
The id of virtual aggregator node, which can be used to retrieve all transactions for the associated Virtual Accounts.
VirtualAccountIdentifiers
object
Identifiers are returned when applicable. The identifiers object is omitted for VIRTUALSUSPENSE and VIRTUALPANDL accounts without account identifiers.
2 properties
2 required
AccountType1
string
Attention \ Please note that the allowed values for the type are extensible and new can be added in the future without a major version change. Please ensure th…
VirtualAccountBase
object
Response object of getting a Virtual Account
18 properties
12 required
CreateVirtualAccountAggregatorNodeId
string
When this field is provided, the Virtual Account is associated with a virtual aggregator node. The virtual aggregator node can then be used to retrieve all tra…
CreateVirtualAccountRequest
object
Request object that is required to create a Virtual Account
3 properties
1 required
CreateVirtualAccountResponse
object
Create Virtual Account response object
5 properties
4 required
GetSingleVirtualAccountResponse
UpdateVirtualAccountAggregatorNodeId
string
The virtual aggregator node, which is linked to the Virtual Account.
UpdateVirtualAccountRequest
object
Request object that is required to update a Virtual Account
2 properties
CloseVirtualAccountRequest
object
Request object that is required to close a Virtual Account
2 properties
TransactionFromDate
string
The oldest posting date from which the transactions will be provided.
TransactionToDate
string
The most recent posting date from which the transactions will be provided.
TransactionIsCreditQueryParam
boolean
Returns the transactions that are credit (isCredit=true) or debit (isCredit=false). If not provided, both credit and debit transactions are returned.
TransactionTypeV3
string
Attention \ Please note that the allowed values for the type are extensible and new values can be added in the future without a major version change. Please en…
TransactionScheme
string
Payment rails for underlying transaction.
TransactionPaymentOrderId
string
Filters transactions associated with the specified paymentOrderId.
TransactionSearch
string
Enables transaction search by sender.reference, recipient.reference, recipient.accountHolderName, typeDescription, and amount.value. The search is case-insensi…
TransactionOrderBy
string
Enables transactions to be ordered by specific fields.
TransactionId
string
Bank of London transaction ID identifies the transaction within Bank of London API platform.
TransactionTypeDescription
string
A short description of the transaction type.
TransactionChannel
string
Attention \ Please note that the allowed values for the channel are extensible and new values can be added in the future without a major version change. Please…
TransactionAccountIdentifierTbol
object
5 properties
5 required
TransactionAccountIdentifierUk
object
4 properties
4 required
TransactionAccountIdentifierINTL
object
5 properties
2 required
TransactionSenderV3
Represents the details of the transaction sender.
TransactionRecipientV3
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. The recipient oneOf is extensible and new recipient types can be…
TransactionOriginator
object
Attention \ Please note that the originator is a oneOf object linked to the type in the object. The originator oneOf is extensible and new originator types can…
TransactionReference
string
Transaction reference
TransactionMandateReference
string
The reference to the mandate ID for Direct Debit transactions
TransactionNotes
string
An arbitrary string attached to the transaction. Max length is 140 characters.
TransactionAmount
object
2 properties
2 required
schemas-TransactionAmount
TransactionPostingDate
string
The date when the transaction was posted and is reflected on the balance of an account.
TransactionReleaseDateTime
string
The date when the transaction was released. This date is generally the same as the posting date unless the transaction was delayed awaiting approval.
TransactionValueDate
string
The date and time when the transaction was actually valued. This is generally the same as the posting date unless the transaction takes place on a weekend or b…
TransactionCreatedDateTime
string
The date when the transaction was created.
ExchangeRate
string
FX rate rounded off to 4 decimal places
QuoteSellCurrency
string
The ISO 4217 currency code representing the currency being sold. This value must correspond to the currency of the source account from which funds are debited.
SellAmount
string
The amount being sold in the sell currency (accepts 0, 1, or 2 decimal places).
QuoteBuyCurrency
string
The ISO 4217 currency code representing the currency being bought. This value must correspond to the currency of the destination account to which funds are cre…
BuyAmount
string
The amount being bought in the buy currency (accepts 0, 1, or 2 decimal places).
TransactionFxDetails
object
Foreign exchange details for the transaction.
3 properties
3 required
AccountBalance
number
Account1
object
2 properties
2 required
TransactionStatus
object
Attention \ Please note that the status is a oneOf object linked to the identifier in the object. The status oneOf, based on the identifier is extensible and n…
PaymentOrderId
string
An ID that allows the linkage of a transaction and a payment
TransactionIsCredit
boolean
Boolean, where true means credit, false stands for debit.
TransactionIsReturn
boolean
Boolean, where true means the funds are returned (depending on the original payment direction could be a debit or a credit), otherwise false implying a fresh p…
PaymentTransactionV3
object
An incoming or outgoing transaction with a sender and recipient.
22 properties
14 required
TransactionFeeTypeV3
string
Attention \ Please note that the allowed values for the type are extensible and new values can be added in the future without a major version change. Please en…
TransactionFeeScheme
string
Payment rails for underlying transaction.
FeeInterestTransactionSender
Attention \ Please note that the sender is a oneOf object linked to the type in the object. The sender oneOf is extensible and new sender types can be added in…
FeeInterestTransactionRecipient
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. The recipient oneOf is extensible and new recipient types can be…
FeeInterestTransactionV3
object
A transaction for fee or earned interest.
16 properties
12 required
AggregatorNodeHeaderAccountId
string
The Header Account associated with the aggregator node.
AggregatorNodeId
string
ID of an aggregator node.
AggregatorNodeAccountOwner
object
Owner of the aggregator node. When it has not been specified the aggregator node will be owned directly by your organisation.
2 properties
2 required
AggregatorNodeName
string
User defined name to identify the aggregator node.
ParentAggregatorNodeId
string
ID of parent Virtual Aggregator Node.
AggregatorNodeResponse
object
Response object for aggregator node operations.
5 properties
3 required
ParentAggregatorNodeIdRequest
string
This allows you to set where in the virtual hierarchy your virtual aggregator node will be positioned. Virtual aggregator nodes can be nested one under another…
CreateAggregatorNodeRequest
object
Request object that is required to create an aggregator node
4 properties
2 required
CreateParentAggregatorNodeIdResponse
string
ID of parent Virtual Aggregator Node as specified in the request. Where it wasn't specified in the request this is the ID of the default virtual aggregator nod…
CreateAggregatorNodeResponse
object
Response object for created virtual aggregator node.
5 properties
4 required
VirtualAccountCount
number
A count of the Virtual Accounts under the virtual aggregator node. This includes those both directly and indirectly below the node.
AggregatedBalance
number
The sum of the balances of the Virtual Accounts under the virtual aggregator node. This includes the balances of Virtual Accounts both directly and indirectly…
GetAggregatorNodeResponse
object
Get aggregator node response object
8 properties
6 required
UpdateAggregatorNodeRequest
object
Request object that is required to update an aggregator node.
2 properties
HierarchyType
string
Type of virtual hierarchy. \ NEGATIVEBALANCEENABLED: Hierarchy with enabled negative balance. Balances of Virtual Accounts in such hierarchy can drop below zer…
HierarchyElementResponse
object
Get Hierarchy response object
4 properties
4 required
CreateVirtualHierarchyRequest
object
Request object that is required to create a virtual hierarchy
1 property
1 required
CreateVirtualHierarchyResponse
object
Create virtual hierarchy response object
1 property
1 required
ConfirmationOfPayeeType
string
The type of Confirmation of Payee check to perform.
ConfirmationOfPayeeName
string
The name to check against the account details. Payee name should not include titles, e.g. Mr, Mrs, Miss, Ms, Dr, etc.
ConfirmationOfPayeeAccountType
string
The type of account to check against.
ConfirmationOfPayeeSortCode
string
The sort code of the account to check against.
ConfirmationOfPayeeAccountNumber
string
The account number to check against.
ConfirmationOfPayeeRequest
object
The request to perform a Confirmation of Payee check.
5 properties
5 required
ConfirmationOfPayeeResultStatus.CONFIRMED
string
The status identifier for a confirmed Confirmation of Payee check.
ConfirmationOfPayeeConfirmedResponse
object
The response from a confirmed Confirmation of Payee check.
1 property
1 required
NullableConfirmationOfPayeeName
string
The name to check against the account details. Payee name should not include titles, e.g. Mr, Mrs, Miss, Ms, Dr, etc.
ConfirmationOfPayeeResultStatus.REJECTED
string
The status identifier for a rejected Confirmation of Payee check.
ConfirmationOfPayeeReasonCode
string
The reason code for a rejected Confirmation of Payee check.
ConfirmationOfPayeeReason
string
The reason for a rejected Confirmation of Payee check.
ConfirmationOfPayeeRejectedResponse
object
The response from a rejected Confirmation of Payee check.
2 properties
1 required
ConfirmationOfPayeeResultStatus.FAILED
string
The status identifier for a failed Confirmation of Payee check.
ConfirmationOfPayeeFailureCode
string
The failure code for a failed Confirmation of Payee check.
ConfirmationOfPayeeFailedResponse
object
The response from a failed Confirmation of Payee check.
1 property
1 required
ConfirmationOfPayeeResponse
FXQuoteSellRequest
object
Request where you specify the amount you want to sell. The system will calculate how much you will receive in the target currency.
2 properties
2 required
FXQuoteBuyRequest
object
Request where you specify the amount you want to buy. The system will calculate how much you need to sell in the source currency.
2 properties
2 required
CreateAnFXQuoteRequest
Request to create an FX quote. The request can be either a sell request where you specify the amount to sell, or a buy request where you specify the amount to…
QuoteId
string
TBOL Quote ID for referencing the generated quote. This quoteId should be used when making an international payment to guarantee the rate.
QuoteExpiresAtDateTime
string
Quote expiration date time in ISO 8601 format. This indicates the time at which the quote will expire and is no longer valid. An cross-border payment must be c…
QuoteCreatedDateTime
string
Quote creation date and time in ISO 8601 format. This indicates the time at which the quote was created.
QuoteType
string
Indicates which amount was specified in the original quote request. - BUY: The buy amount was provided in the request - SELL: The sell amount was provided in t…
CreateAnFXQuoteResponse
object
7 properties
7 required
AccountIdentifierTbol
object
2 properties
2 required
PaymentSender
Attention \ Please note that the sender is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the sender on…
PaymentRecipientTbol
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the recipi…
Amount
object
2 properties
2 required
PaymentAmount
PaymentReferenceRequest
string
Reference note that is sent along with the payment and usually contains personal or business related information. This is visible to the sender and the recipie…
PaymentNotes
string
This is available for additional information to be shared with the recipient to help them identify the payment. This is visible to the sender and may be visibl…
PlannedPaymentExecutionDateTime
string
The date and time when the payment should be executed by The Bank of London. Future date and time up to 90 days can be provided to schedule a future payment. T…
IdempotencyId
string
Idempotency ID is a unique identifier that will guarantee that a payment or standing order containing a specific ID will be processed only once.
PaymentId
string
Payment ID identifies the payment within Bank of London API platform.
InternalDebitPaymentType
string
Represents an immediate or future internal payment.
InternalPaymentScheme
string
Payment scheme. INTERNAL: Internal payment
PaymentSenderResponse
object
Attention \ Please note that the sender is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the sender on…
4 properties
4 required
AccountIdentifierTbolResponse
object
5 properties
5 required
PaymentRecipientTbolResponse
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the recipi…
PaymentReference
Reference note that is sent along with the payment and usually contains personal or business related information. This is visible to the sender and the recipie…
PaymentStatusHistory
object
Represents the history of the payment status.
2 properties
2 required
PaymentStatus
Attention \ Please note that the status is a oneOf object linked to the identifier in the object. The status oneOf, based on the identifier is extensible and n…
ExecutionDateTime
string
The UTC date time when the payment was executed. This field is only populated once the payment has been settled and status identifier is SUCCESSFUL.
CreatedDateTime
string
The UTC date time when the payment was created 2022-10-05T11:01:00.000Z is a valid example.
CreatedBy
string
The id of the user or application that created the payment. System generated payments use a reserved value of SYSTEM.
PaymentStandingOrderId
string
Standing order ID identifies a standing order linked to a payment. Only payments of type INTERNALSTANDINGORDERDEBIT or FPSSTANDINGORDERDEBIT will have a standi…
PaymentCreatorUserType
string
The type of the payment creator. Created by a user.
PaymentCreatorId
string
The id of the user that created the payment.
PaymentCreatorUser
object
Represents the creator of the payment.
2 properties
2 required
PaymentCreatorApiType
string
The type of the payment creator. Created by the API.
PaymentCreatorKey
string
The API key that created the payment.
PaymentCreatorApi
object
Represents the creator of the payment.
2 properties
2 required
PaymentCreatorSystemType
string
The type of the payment creator. Created by the system, usually standing order payments.
PaymentCreatorSystem
object
Represents the creator of the payment.
1 property
1 required
PaymentCreator
PaymentType
string
Represents payment type for agency payments. SIP: Single Immediate Payment \ FDP: Forward Dated Payment \ SOP: Standing Order Payment.
AccountIdentifierUk
object
4 properties
4 required
PaymentOriginator
Represents the details of the payment originator for agency payments.
InternalSinglePayment
object
Payment object that represents an Internal payment.
19 properties
12 required
PaymentRecipient
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. Currently UK is the only available oneOf object but the recipien…
FPSDebitPaymentType
string
Represents an immediate or future FPS payment.
FPSPaymentScheme
string
Payment scheme. FPS: Faster payment
RedirectedSortCode
string
Provided along with redirectedAccountNumber if the original payment was redirected to a different account than originally instructed, due to the recipient’s ac…
RedirectedAccountNumber
string
Provided along with redirectedSortCode if the original payment was redirected to a different account than originally instructed, due to the recipient’s account…
AccountIdentifierFPS
object
6 properties
4 required
PaymentRecipientFPSResponse
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. Currently UK is the only available oneOf object but the recipien…
FPSSinglePayment
object
Payment object that represents a FPS payment.
19 properties
12 required
BacsSinglePaymentItem
object
Payment object that represents a single Bacs payment item.
4 properties
3 required
PlannedPaymentExecutionDate
string
The date when the payment should be executed by Bank of London. Any future date can be provided to schedule a future payment. Payments are processed in the Eur…
BacsDebitPaymentRequest
object
Payment object that is required to initiate a single Bacs Debit payment.
5 properties
5 required
BacsDebitPaymentType
string
Represents a Bacs payment.
BacsPaymentScheme
string
Payment scheme. BACS: Bacs payment
BacsExecutionDateTime
string
The UTC date time detailing when the payment will settle. This field is populated once the payment has successfully passed our checks and prepared for the paym…
BacsSinglePayment
object
Payment object that is required to initiate a single Bacs payment.
13 properties
11 required
ChapsPaymentAmount
object
2 properties
2 required
PlannedChapsPaymentExecutionDateTime
string
The date when the payment should be executed by Bank of London. Today's date or the next working day can be provided. The date time should be formatted to the…
CHAPSDebitPaymentType
string
Represents a CHAPS payment.
CHAPSPaymentScheme
string
Payment scheme. CHAPS: CHAPS payment
CHAPSSinglePayment
object
Payment object that is required to initiate a CHAPS payment.
16 properties
12 required
PaymentScheme
string
Attention \ Please note that the allowed values for the scheme are extensible and new values can be added in the future without a major version change. Please…
PaymentStatusQueryParam
string
Payment statuses listed below can be used as query values. In order to query for \ multiple statuses, the query param can be repeated \ e.g ...?status=PENDING&…
value
number
The amounts value assuming the provided unit under currency.
PaymentTypeQueryParam
string
Represents the type of payment.
CrossBorderEndToEndId
string
Unique identifier that must be unique for the entire end-to-end payment journey. This identifier is used to track the payment across all systems and institutio…
CrossBorderPaymentScheme
string
Payment scheme. CROSSBORDER: Cross-border payment
CrossBorderQuoteId
string
Quote Id is not a required field for cross-border payments. \ A Quote Id can be provided by the FX quote API, in order to guarantee the rate. The quoteId must…
CrossBorderDebtor
object
Debtor - The party that is sending the payment.
1 property
1 required
CrossBorderAmountCurrency
string
Currency Code (ISO4217) of the creditor account. \ Attention \ Please note that the allowed values for the currency are extensible and new values can be added…
CrossBorderAmountValue
string
Amount to be paid to the creditor (accepts 0, 1, or 2 decimal places)
CrossBorderAmount
object
Amount you want to send to the creditor and is expressed in the currency you are sending.
2 properties
2 required
FinancialInstitutionBIC
string
Business Identifier Code of the financial institution
CreditorAgentCountry
string
Country code (ISO) for the associated bank identifier provided.
CreditorAgentBankIdentifier
string
Bank identifier for the payment based on the region where the payment is identified. Examples include: - U.S. ABA routing number (e.g., 021000021) - Australia…
CrossBorderCreditorAgent
Creditor Agent's Business Identifier Code. Either BIC or Other identification must be present.
PartyName
string
Name of the party
PostalAddressTownName
string
Town name (mandatory for postal address)
PostalAddressCountry
string
Two-letter ISO country code (mandatory for postal address)
PostalAddressDepartment
string
Department information
PostalAddressSubDepartment
string
Sub-department information
PostalAddressStreetName
string
Street name
PostalAddressBuildingNumber
string
Building number
PostalAddressBuildingName
string
Building name
PostalAddressFloor
string
Floor information
PostalAddressPostBox
string
Post box information
PostalAddressRoom
string
Room information
PostalAddressPostCode
string
Postal code
PostalAddressTownLocationName
string
Town location name
PostalAddressDistrictName
string
District name
PostalAddressCountrySubDivision
string
Country subdivision
CrossBorderPostalAddress
object
Postal address information for cross-border payments
14 properties
2 required
CrossBorderAccountIBAN
string
IBAN details for the account
CrossBorderAccountOther
string
Account details based on clearing system (account number, ABA code, etc.)
CrossBorderCreditorAccount
IBAN details for the creditor account or account number. Important Conditional Requirements: - If Other is selected for creditorAgent, then IBAN cannot be sele…
CrossBorderCreditor
object
Information about the creditor of the transaction.
3 properties
3 required
CrossBorderFxDetails
object
Foreign exchange details used to create the cross-border payment. This object will only be present if the currency of the debitor account is different to the c…
3 properties
3 required
UnstructuredReference
string
Unstructured reference. This is available for additional information to be shared with the recipient to help them identify the payment. This is visible to the…
CrossBorderReference
Reference for cross-border payments. Currently supports unstructured format only.
CrossBorderPaymentStatus
Attention \ Please note that the status is a oneOf object linked to the identifier in the object. The status oneOf, based on the identifier is extensible and n…
CrossBorderCreatedDateTime
string
Date and time at which the message was created.
CrossBorderPlannedExecutionDate
string
Date on which the payment has to be executed (ISO 8601 YYYY-MM-DD format - e.g., 2025-06-16). System generated.
BaseCrossBorderPaymentResponse
object
Base payment response object with common properties for cross-border payments.
17 properties
12 required
CrossBorderDirectPaymentResponse
object
Cross-border payment response for direct payments.
CrossBorderPaymentResponse
Attention \ Please note that the response is a oneOf object. The response oneOf is extensible and new response types can be added in the future without a major…
GatewayTimeoutError
CrossBorderDirectPaymentRequest
object
Cross-border payment request for direct payments (non-agency)
9 properties
7 required
CrossBorderPaymentRequest
ServiceUnavailableError
StandingOrderSender
Attention \ Please note that the sender is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the sender on…
StandingOrderUKRecipient
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. The recipient oneOf is extensible and new recipient types can be…
StandingOrderAmount
PaymentFrequency
string
Frequency of a standing order payment. Bank of London will use this value to set the payment execution dates after the date of first execution (startDateTime).…
StartDateTime
string
The date when the standing order payment should be executed by The Bank of London. Future date and time up to 90 days can be provided to schedule a future paym…
NumberOfPayments
integer
The number of payments that should be made for a standing order.
EndDateTime
string
The date when the standing order payment should be executed by The Bank of London. Any future date can be provided to schedule a future payment. The date time…
StandingOrderSchedule
object
Represents the details of the standing order schedule. frequency is required, then either numberOfPayments or endDateTime must be provided.
4 properties
1 required
PaymentReferenceRequest1
string
Reference note that is sent along with the related payments and usually contains personal or business related information. This is visible to the sender and th…
PaymentNotes1
string
This is available for additional information to be shared with the recipient to help them identify the related payments. This is visible to the sender and may…
StandingOrderId
string
Standing order ID identifies the standing order within The Bank of London API platform.
StandingOrderSenderResponse
object
Attention \ Please note that the sender is a oneOf object linked to the type in the object. Currently TBOL is the only available oneOf object but the sender on…
4 properties
4 required
StandingOrderStatusHistory
object
Represents the history of the standing order status.
3 properties
3 required
StandingOrderStatus
Attention \ Please note that the status is a oneOf object linked to the identifier in the object. The status oneOf, based on the identifier is extensible and n…
CreatedBy1
string
The id of the user or application that created the payment.
PaymentReference1
Reference note that is sent along with the related payments and usually contains personal or business related information. This is visible to the sender and th…
StandingOrderCancellation
object
Represents the details of the standing order cancellation.
3 properties
1 required
StandingOrderCreatorUserType
string
The type of the standing order creator. Created by a user.
StandingOrderCreatorId
string
The id of the user that created the payment.
StandingOrderCreatorUser
object
Represents the creator of the standing order.
2 properties
2 required
StandingOrderCreatorApiType
string
The type of the standing order creator. Created by the API.
StandingOrderCreatorKey
string
The API key that created the payment.
StandingOrderCreatorApi
object
Represents the creator of the standing order.
2 properties
2 required
StandingOrderCreatorSystemType
string
The type of the standing order creator. Created by the system.
StandingOrderCreatorSystem
object
Represents the creator of the standing order.
1 property
1 required
StandingOrderCreator
FPSStandingOrder
object
A standing order.
14 properties
12 required
StandingOrderInternalRecipient
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. The recipient oneOf is extensible and new recipient types can be…
StandingOrderInternalRecipientResponse
Attention \ Please note that the recipient is a oneOf object linked to the type in the object. The recipient oneOf is extensible and new recipient types can be…
InternalStartDateTime
string
The date when the standing order payment should be executed by The Bank of London. Future date and time up to 90 days can be provided to schedule a future paym…
InternalStandingOrderSchedule
object
Represents the details of the standing order schedule. frequency is required, then either numberOfPayments or endDateTime must be provided.
4 properties
1 required
InternalStandingOrder
object
A standing order.
14 properties
12 required
StandingOrderScheme
string
Attention \ Please note that the allowed values for the scheme are extensible and new values can be added in the future without a major version change. Please…
StandingOrderStatusQueryParam
string
Standing order statuses listed below can be used as query values. In order to query for \ multiple statuses, the query param can be repeated \ e.g ...?status=P…
TransactionQueryScheme
string
Returns transactions of the specified transaction scheme.
Account2
object
2 properties
2 required
PaymentTransactionV31
object
An incoming or outgoing transaction with a sender and recipient.
22 properties
14 required
TransactionExportId
string
Identifier of the transaction export within Bank of London API platform.
TransactionExportCreatedDateTime
string
The date and time when the transaction export was created.
TransactionExportStatus
string
The status of the transaction export.
NullableTransactionToDate
string
The most recent posting date from which the transactions will be provided.
NullableTransactionIsCreditQueryParam
boolean
Returns the transactions that are credit (isCredit=true) or debit (isCredit=false). If not provided, both credit and debit transactions are returned.
NullableTransactionFieldsV3
array
Returns only the fields that you have specified. If not provided, all fields will be returned.
TransactionBaseV3
object
Common properties for transactions
8 properties
5 required
TransactionExportFileFormat
string
The file export format. PDF transaction export supports maximum of 2000 transactions.
TransactionExportDownloadUrl
string
The transaction export download url - this is only available when the transaction export status is COMPLETED.
TransactionExportV3
TransactionExportV3WithoutDownloadUrl
InitiateTransactionExportV3Body
object
Request body to initiate a transaction export
7 properties
3 required
InitiateTransactionExportV3Response
RequestEntityTooLargeError
MandateReference
string
The reference to the mandate ID
MandateId
string
Bank of London mandate ID identifies the mandate within Bank of London API platform.
MandateType
string
The type of mandate
MandateScheme
string
The scheme of the mandate
MandateSender
object
4 properties
4 required
MandateRecipient
object
2 properties
2 required
MandateLastAmountPaid
object
2 properties
2 required
MandateStatus
object
1 property
1 required
MandateCancellationReasonCode
string
A code representing the reason that a mandate was cancelled
MandateCancellation
object
2 properties
1 required
Mandate
object
A mandate object
9 properties
8 required
MandateCancel
object
Request body of mandate cancellation
1 property
StatementId
string
Bank of London statement ID identifies the statement within Bank of London API platform
StatementStartDate
string
Identifies the start date of statement's period
StatementEndDate
string
Identifies the end date of statement's period
StatementName
string
Identifies the end of the statement
StatementType
string
Identifies type of statement
AccountType2
string
Attention \ Please note that the allowed values for the type are extensible and new can be added in the future without a major version change. Please ensure th…
Statement
object
Response object of getting a statement
9 properties
9 required
WebhookId
string
The id of the webhook
WebhookName
string
The name of the webhook. - Name must be unique within an environment (sandbox or live) for an account.
Url
string
The url of webhook target. - Url must be https. - A combination of the version and url must be unique within an environment (sandbox or live) for an account.
WebhookEvent
string
Attention \ Please note that the allowed values for the events are extensible and new values can be added in the future without a major version change. Please…
WebhookVersion
number
The version of API to subscribe to. A combination of the url and version must be unique within an environment (sandbox or live) for an account.
WebhookEnabledStatus
boolean
Indicates whether the webhook is enabled or not.
WebhookPublicKey
string
The public key of the webhook.
WebhookCreatedDate
string
The date and time the webhook was created.
Webhook
object
8 properties
8 required
NullableWebhookName
string
The name of the webhook. - Name must be unique within an environment (sandbox or live) for an account.
NullableUrl
string
The url of webhook target. - Url must be https. - A combination of the version and url must be unique within an environment (sandbox or live) for an account.
NullableWebhookVersion
number
The version of API to subscribe to. A combination of the url and version must be unique within an environment (sandbox or live) for an account.
NullableWebhookEnabledStatus
boolean
Indicates whether the webhook is enabled or not.
RegenerateWebhookKeyResponse
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Banking#Payments#Account#Virtual Accounts#Faster Payments#Bacs#CHAPS#Confirmation of Payee#Direct Debits#Webhook
Where this information came from
This is an independent, third-party profile of Bank of London API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.