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 Transactions API

The Transactions API from Yorkshire Building Society — 3 operation(s) for transactions.

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

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

3 operations 3 paths 50 schemas 3 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 Transactions 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 3

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

Transactions 3
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Transactions
GetAccountsAccountIdStatementsStatementIdTransactions 6 params → 200400401403404405406429
GET
/accounts/{AccountId}/transactions
Get Transactions
GetAccountsAccountIdTransactions 7 params → 200400401403404405406429
GET
/transactions
Get Transactions
GetTransactions 6 params → 200400401403404405406429

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are OBTransaction5Detail (23 properties), OBTransaction5Basic (16 properties), OBPostalAddress6 (10 properties), OBCurrencyExchange5 (7 properties). Each schema is shown below with its type and property counts.

OBTransaction5Basic
object
Provides further details on an entry in the report.
16 properties 5 required
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
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
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties 1 required
StreetName
string
Name of a street or thoroughfare.
OBTransaction5
OBCreditDebitCode_2
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
4 properties
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties 2 required
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction.
4 properties 1 required
OBReadTransaction5
object
3 properties 1 required
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
TransactionId
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
BuildingNumber
string
Number that identifies the position of a building on a street.
OBEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer.
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:…
OBTransaction5Detail
object
Provides further details on an entry in the report.
23 properties 5 required
OBBranchAndFinancialInstitutionIdentification6_0
object
Financial institution servicing an account for the creditor.
4 properties
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
4 properties
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBBalanceType1Code
string
Balance type, in a coded form.
ValueDateTime
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit…
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…
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties 2 required
Links
object
Links relevant to the payload
5 properties 1 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money in the cash transaction entry.
2 properties 2 required
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the debtor.
4 properties
TransactionReference
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
OBReadDataTransaction5
object
1 property
Name_2
string
Name by which an agent is known and which is usually used to identify that agent.
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
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…
BookingDateTime
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the st…
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
OBActiveOrHistoricCurrencyAndAmount_8
object
Transaction charges to be paid by the charge bearer.
2 properties 2 required
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…
OBTransactionCashBalance
object
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied…
3 properties 3 required
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yorkshire-building-society-transactions-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 Transactions 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.