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 Scheduled Payments API

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

Yorkshire Building Society 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 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 2 operations across 2 paths, and defines 24 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/aisp.

2 operations 2 paths 24 schemas 2 GET

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 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 2

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

Scheduled Payments 2
GET
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments
GetAccountsAccountIdScheduledPayments 5 params → 200400401403404405406429
GET
/scheduled-payments
Get Scheduled Payments
GetScheduledPayments 4 params → 200400401403404405406429

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are OBScheduledPayment2Detail (8 properties), OBScheduledPayment2Basic (6 properties), Links (5 properties), OBErrorResponse1 (4 properties). Each schema is shown below with its type and property counts.

OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBBranchAndFinancialInstitutionIdentification5_1
object
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on t…
2 properties 2 required
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
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage:…
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:…
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBScheduledPayment2Detail
object
8 properties 5 required
Links
object
Links relevant to the payload
5 properties 1 required
OBExternalScheduleType1Code
string
Specifies the scheduled payment date type requested
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
OBScheduledPayment2
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBReadScheduledPayment2
object
3 properties 1 required
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…
ScheduledPaymentDateTime
string
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respo…
OBScheduledPayment2Basic
object
6 properties 4 required
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
4 properties 2 required
OBError1
object
4 properties 2 required
Reference
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this…
ActiveOrHistoricCurrencyCode_1
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…
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-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 Scheduled Payments API
Yorkshire Building Society Domestic Standing Orders API
Yorkshire Building Society Event Subscriptions API
Yorkshire Building Society File Payments API
Where this information came from

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