Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Lloyds Banking Group Confirmation of Funds API

OBIE Read/Write Confirmation of Funds (CBPII) API allowing an authorised card-based payment instrument issuer to check whether funds are available on a customer account. FAPI-secured (OAuth2/OIDC, mTLS, PSD2 SCA); requires developer-portal onboarding and Open Banking directory registration. Spec provenance is the shared OBIE Read/Write standard, not a Lloyds-proprietary contract.

Lloyds Banking Group Confirmation of Funds API is one of 6 APIs that Lloyds Banking Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Confirmation of Funds, CBPII, and Open Banking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, organized into 2 resource areas, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/cbpii.

4 operations 3 paths 15 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Base URL
https://api.lloydsbank.com/open-banking/v3.1
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
2

Authentication & Security 2

Lloyds Banking Group Confirmation of Funds API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. They span 2 resource areas: Funds Confirmation Consents, Funds Confirmations. Each is listed below with its method, path, parameters, and response codes.

Funds Confirmation Consents 3
POST
/funds-confirmation-consents
Create a Funds Confirmation Consent
CreateFundsConfirmationConsents 6 params body → 201400401403405406415429
GET
/funds-confirmation-consents/{ConsentId}
Get a Funds Confirmation Consent
GetFundsConfirmationConsentsConsentId 7 params → 200400401403405406429500
DELETE
/funds-confirmation-consents/{ConsentId}
Delete a Funds Confirmation Consent
DeleteFundsConfirmationConsentsConsentId 7 params → 204400401403405406429500
Funds Confirmations 1
POST
/funds-confirmations
Create a Funds Confirmation Request
CreateFundsConfirmations 6 params body → 201400401403405406415429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties), OBFundsConfirmationResponse1 (3 properties). Each schema is shown below with its type and property counts.

Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties 2 required
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values refer to ExternalProxyAccou…
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
Links
object
Links relevant to the payload
5 properties 1 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBFundsConfirmation1
object
1 property 1 required
OBFundsConfirmationConsent1
object
1 property 1 required
OBFundsConfirmationConsentResponse1
object
3 properties 1 required
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form. For a full list of values refer to OBInternalConsentStatus1Code in OBInternalCodeSet [here](https://gith…
OBFundsConfirmationResponse1
object
3 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBStatusReason
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

obie-confirmation-funds-openapi.yaml Raw ↑

Other APIs Lloyds Banking Group publishes across the network.

Lloyds Banking Group Open Data API
Lloyds Banking Group Account and Transaction Information API
Lloyds Banking Group Payment Initiation API
Lloyds Banking Group Variable Recurring Payments API
Lloyds Banking Group Event Notifications API