OBIE Read/Write Payment Initiation (PISP) API v3.1.2 - lets FCA-authorised payment initiation service providers set up domestic single, scheduled, standing-order and file payment consents and initiate payments from consenting YBS and Chelsea Building Society accounts. FAPI-secured (OAuth2/OIDC, mTLS, PSD2 SCA).
Yorkshire Building Society Payment Initiation 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 Payment Initiation, PISP, and Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes
41 operations
across 40 paths,
organized into 8 resource areas,
and defines 57 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/pisp.
41 operations40 paths57 schemas26 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Yorkshire Building Society Payment Initiation 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 41
Across 40 paths, the API surfaces 41 operations — 26 GET, 15 POST. They span 8 resource areas: Domestic Payments, Payment Details, Domestic Scheduled Payments, Domestic Standing Orders, File Payments, International Payments, International Scheduled Payments, International Standing Orders. Each is listed below with its method, path, parameters, and response codes.
The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), Links (5 properties), OBWriteInternationalStandingOrderConsentResponse4 (4 properties), OBWriteDomesticScheduledConsentResponse3 (4 properties). Each schema is shown below with its type and property counts.
ActiveOrHistoricCurrencyCode
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
BuildingNumber
string
Number that identifies the position of a building on a street.
CountryCode
string
Nation with its own government.
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
Department
string
Identification of a division of a large organisation or building.
File
object
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:…
Identification
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Links
object
Links relevant to the payload
5 properties1 required
Meta
object
Meta Data relevant to the payload
3 properties
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties2 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBError1
object
4 properties2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
4 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBWriteDomestic2
object
2 properties2 required
OBWriteDomesticConsent3
object
2 properties2 required
OBWriteDomesticConsentResponse3
object
4 properties2 required
OBWriteDomesticResponse3
object
3 properties1 required
OBWriteDomesticScheduled2
object
2 properties2 required
OBWriteDomesticScheduledConsent3
object
2 properties2 required
OBWriteDomesticScheduledConsentResponse3
object
4 properties2 required
OBWriteDomesticScheduledResponse3
object
3 properties1 required
OBWriteDomesticStandingOrder3
object
2 properties2 required
OBWriteDomesticStandingOrderConsent4
object
2 properties2 required
OBWriteDomesticStandingOrderConsentResponse4
object
4 properties2 required
OBWriteDomesticStandingOrderResponse4
object
3 properties1 required
OBWriteFile2
object
1 property1 required
OBWriteFileConsent3
object
1 property1 required
OBWriteFileConsentResponse3
object
3 properties1 required
OBWriteFileResponse2
object
3 properties1 required
OBWriteFundsConfirmationResponse1
object
3 properties1 required
OBWriteInternational2
object
2 properties2 required
OBWriteInternationalConsent3
object
2 properties2 required
OBWriteInternationalConsentResponse3
object
4 properties2 required
OBWriteInternationalResponse3
object
3 properties1 required
OBWriteInternationalScheduled2
object
2 properties2 required
OBWriteInternationalScheduledConsent3
object
2 properties2 required
OBWriteInternationalScheduledConsentResponse3
object
4 properties2 required
OBWriteInternationalScheduledResponse3
object
3 properties1 required
OBWriteInternationalStandingOrder3
object
2 properties2 required
OBWriteInternationalStandingOrderConsent4
object
2 properties2 required
OBWriteInternationalStandingOrderConsentResponse4
object
4 properties2 required
OBWriteInternationalStandingOrderResponse4
object
3 properties1 required
OBWritePaymentDetailsResponse1
object
3 properties1 required
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
StreetName
string
Name of a street or thoroughfare.
SubDepartment
string
Identification of a sub-division of a large organisation or building.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
Specification
The full machine-readable OpenAPI contract behind this narrative.
