Yorkshire Building Society Domestic Payments API is one of 24 APIs that Yorkshire Building Society publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Domestic 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
5 operations
across 5 paths,
and defines 31 schemas.
It is described by OpenAPI 3.2.0, at version v3.1.2.
Requests are made against a single base URL, https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/pisp.
5 operations5 paths31 schemas3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Yorkshire Building Society Domestic Payments 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 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), Links (5 properties), OBError1 (4 properties), OBRisk1 (4 properties). Each schema is shown below with its type and property counts.
CountryCode
string
Nation with its own government.
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
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.
Meta
object
Meta Data relevant to the payload
3 properties
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties2 required
Department
string
Identification of a division of a large organisation or building.
StreetName
string
Name of a street or thoroughfare.
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…
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBWriteDomesticConsent3
object
2 properties2 required
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBWriteDomestic2
object
2 properties2 required
OBWriteDomesticConsentResponse3
object
4 properties2 required
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 properties1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
OBWriteFundsConfirmationResponse1
object
3 properties1 required
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
Identification
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
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…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
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.
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBError1
object
4 properties2 required
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…
OBWriteDomesticResponse3
object
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Yorkshire Building Society Domestic Payments 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.
