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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yorkshire Building Society

Yorkshire Building Society File Payments API

The File Payments API from Yorkshire Building Society — 6 operation(s) for file payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yorkshire Building Society File 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 File 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 7 operations across 6 paths, and defines 20 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 6 paths 20 schemas 4 GET3 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
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Yorkshire Building Society File 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 7

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

File Payments 7
POST
/file-payment-consents
Create File Payment Consents
CreateFilePaymentConsents 6 params body → 201400401403404405406429
GET
/file-payment-consents/{ConsentId}
Get File Payment Consents
GetFilePaymentConsentsConsentId 5 params → 200400401403404405406429
POST
/file-payment-consents/{ConsentId}/file
Create File Payment Consents
CreateFilePaymentConsentsConsentIdFile 7 params body → 200400401403404405406429
GET
/file-payment-consents/{ConsentId}/file
Get File Payment Consents
GetFilePaymentConsentsConsentIdFile 5 params → 200400401403404405406429
POST
/file-payments
Create File Payments
CreateFilePayments 6 params body → 201400401403404405406429
GET
/file-payments/{FilePaymentId}
Get File Payments
GetFilePaymentsFilePaymentId 5 params → 200400401403404405406429
GET
/file-payments/{FilePaymentId}/report-file
Get File Payments
GetFilePaymentsFilePaymentIdReportFile 5 params → 200400401403404405406429

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBError1 (4 properties), OBErrorResponse1 (4 properties), OBWriteFileResponse2 (3 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.
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
File
object
OBWriteFile2
object
1 property 1 required
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…
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
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
Identification
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
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…
OBWriteFileConsent3
object
1 property 1 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBWriteFileConsentResponse3
object
3 properties 1 required
OBWriteFileResponse2
object
3 properties 1 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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-file-payments-api-openapi.yml Raw ↑

Other APIs Yorkshire Building Society publishes across the network.

Yorkshire Building Society Dynamic Client Registration API
AE Profile APIs.io
Yorkshire Building Society Generate Access Token API
AE Profile APIs.io
Yorkshire Building Society Account Access API
AE Profile APIs.io
Yorkshire Building Society Accounts API
AE Profile APIs.io
Yorkshire Building Society Balances API
AE Profile APIs.io
Yorkshire Building Society Beneficiaries API
AE Profile APIs.io
Yorkshire Building Society Direct Debits API
AE Profile APIs.io
Yorkshire Building Society Domestic Payments API
AE Profile APIs.io
Yorkshire Building Society Domestic Scheduled Payments API
AE Profile APIs.io
Yorkshire Building Society Domestic Standing Orders API
AE Profile APIs.io
Yorkshire Building Society Event Subscriptions API
AE Profile APIs.io
Yorkshire Building Society Funds Confirmations API
AE Profile APIs.io
#File Payments
← Back to Y APIs
API Details
ID
yorkshire-building-society:yorkshire-building-society-file-payments-api
Base URL
https://ob-ybs.api.ybs.co.uk/open-banking/v3.1/aisp
Docs
https://developers.ybs.co.uk/api-catalog/account-information-api
Provider
Yorkshire Building Society
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yorkshire-building-society-file-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yorkshire-building-society-file-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 File 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.