How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yorkshire Building Society Domestic Scheduled Payments API

The Domestic Scheduled Payments API from Yorkshire Building Society — 4 operation(s) for domestic scheduled payments.

Yorkshire Building Society Domestic Scheduled 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 Scheduled 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 4 operations across 4 paths, and defines 30 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.

4 operations 4 paths 30 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3.1.2
Base URL
https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Yorkshire Building Society Domestic Scheduled 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 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Domestic Scheduled Payments 4
POST
/domestic-scheduled-payment-consents
Create Domestic Scheduled Payment Consents
CreateDomesticScheduledPaymentConsents 6 params body → 201400401403404405406429
GET
/domestic-scheduled-payment-consents/{ConsentId}
Get Domestic Scheduled Payment Consents
GetDomesticScheduledPaymentConsentsConsentId 5 params → 200400401403404405406429
POST
/domestic-scheduled-payments
Create Domestic Scheduled Payments
CreateDomesticScheduledPayments 6 params body → 201400401403404405406429
GET
/domestic-scheduled-payments/{DomesticScheduledPaymentId}
Get Domestic Scheduled Payments
GetDomesticScheduledPaymentsDomesticScheduledPaymentId 5 params → 200400401403404405406429

Schemas 30

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

CountryCode
string
Nation with its own government.
OBWriteDomesticScheduledConsentResponse3
object
4 properties 2 required
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 properties 2 required
StreetName
string
Name of a street or thoroughfare.
Department
string
Identification of a division of a large organisation or building.
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.
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBWriteDomesticScheduledConsent3
object
2 properties 2 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 properties 1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 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
OBWriteDomesticScheduledResponse3
object
3 properties 1 required
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
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…
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 properties 2 required
OBWriteDomesticScheduled2
object
2 properties 2 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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-domestic-scheduled-payments-api-openapi.yml Raw ↑

Other APIs Yorkshire Building Society publishes across the network.

Yorkshire Building Society Dynamic Client Registration API
Yorkshire Building Society Generate Access Token API
Yorkshire Building Society Account Access API
Yorkshire Building Society Accounts API
Yorkshire Building Society Balances API
Yorkshire Building Society Beneficiaries API
Yorkshire Building Society Direct Debits API
Yorkshire Building Society Domestic Payments API
Yorkshire Building Society Domestic Standing Orders API
Yorkshire Building Society Event Subscriptions API
Yorkshire Building Society File Payments API
Yorkshire Building Society Funds Confirmations API
Where this information came from

This is an independent, third-party profile of Yorkshire Building Society Domestic Scheduled 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.