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 Payment Details API

The Payment Details API from Yorkshire Building Society — 7 operation(s) for payment details.

Yorkshire Building Society Payment Details 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 Payment Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 7 paths, and defines 7 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.

7 operations 7 paths 7 schemas 7 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 Payment Details 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 7

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

Payment Details 7
GET
/domestic-payments/{DomesticPaymentId}/payment-details
Get Payment Details
GetDomesticPaymentsDomesticPaymentIdPaymentDetails 5 params → 200400401403404405406429
GET
/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
Get Payment Details
GetDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails 5 params → 200400401403404405406429
GET
/domestic-standing-orders/{DomesticStandingOrderId}/payment-details
Get Payment Details
GetDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails 5 params → 200400401403404405406429
GET
/file-payments/{FilePaymentId}/payment-details
Get Payment Details
GetFilePaymentsFilePaymentIdPaymentDetails 5 params → 200400401403404405406429
GET
/international-payments/{InternationalPaymentId}/payment-details
Get Payment Details
GetInternationalPaymentsInternationalPaymentIdPaymentDetails 5 params → 200400401403404405406429
GET
/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
Get Payment Details
GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails 5 params → 200400401403404405406429
GET
/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
Get Payment Details
GetInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails 5 params → 200400401403404405406429

Schemas 7

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

Meta
object
Meta Data relevant to the payload
3 properties
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
OBError1
object
4 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…
OBWritePaymentDetailsResponse1
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-payment-details-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 Payment Details 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.