Yorkshire Building Society Confirmation of Funds API
OBIE Read/Write Confirmation of Funds (CBPII) API v3.1.2 - lets FCA-authorised card-based payment instrument issuers set up a funds confirmation consent and confirm whether a specified amount is available on a consenting YBS or Chelsea Building Society account. FAPI-secured (OAuth2/OIDC, mTLS, PSD2 SCA).
Yorkshire Building Society Confirmation of Funds API is one of 6 APIs that Yorkshire Building Society 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, an API reference, and a getting-started guide.
This API exposes 4 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version v3.1.2.
Requests are made against the base URL https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/cbpii.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Yorkshire Building Society 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 ASPSPPSUOAuth2Security— 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. Each is listed below with its method, path, parameters, and response codes.
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties), OBFundsConfirmationConsentResponse1 (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yorkshire Building Society 5
Other APIs Yorkshire Building Society publishes across the network.