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

Barclays Accounts API

Get Accounts

Barclays Accounts API is one of 64 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 6 paths, and defines 53 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against the base URL https://telesto.api.barclays/open-banking/v3.1.

6 operations 6 paths 53 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://telesto.api.barclays/open-banking/v3.1
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Barclays Accounts 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 6

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

Accounts 6

Get Accounts

GET
/accounts/{accountId}
Get an Account by AccountId
GetAccountsAccountId 6 params → 200400401500403405406429
GET
/accounts
Get Accounts
GetAccounts 5 params → 200400401500403405406429
GET
/accounts/{account-id}
Get accounts account id
get_accounts__account-id_ 14 params → 200400401404
GET
/accounts/{account-id}/transactions
Get accounts account id transactions
get_accounts__account-id__transactions 17 params → 200400401404
GET
/accounts/{account-id}/balances
Get accounts account id balances
get_accounts__account-id__balances 13 params → 200400401404
GET
/accounts/{account-id}/transactions/{transactionId}
Get accounts account id transactions transaction id
get_accounts__account-id__transactions__transactionId_ 14 params → 200400401404

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBAccount6 (14 properties), get_account_details_response (7 properties), GetAccountsAccountIdTransactionsTransactionid400Response (5 properties). Each schema is shown below with its type and property counts.

OBFileFormat
string
For a full list of enumeration values refer to ExternalDocumentFormat1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSe…
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
OBReadAccount6
object
3 properties 1 required
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group) For a full list of enumeration values refer to OBExternalCashAccountType1Code OBInternalCodeSet [here]…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Links
object
Links relevant to the payload
5 properties 1 required
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
Room
string
Information that locates and identifies a room to form part of an address
OBInternalAccountStatus1Code
string
Specifies the status of account resource in code form. For a full list of enumeration values refer to OBInternalAccountStatus1Code in OBInternalCodeSet [here](…
OpeningDate
string
Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8…
StatementFrequencyAndFormat
array
OBError1
object
4 properties 1 required
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…
OBInternalSwitchStatusCode
string
Specifies the switch status for the account, in a coded form. For a full list of enumeration values refer to OBInternalSwitchStatusCode in OBInternalCodeSet [h…
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
OBFrequency2
string
For a full list of enumeration values refer to OBFrequency2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSets)
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…
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…
StatusUpdateDateTime
string
Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in re…
BuildingNumber
string
Number that identifies the position of a building on a street.
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
MaturityDate
string
Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the t…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
ActiveOrHistoricCurrencyCode_0
string
Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currenc…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBBranchAndFinancialInstitutionIdentification5_0
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…
3 properties 2 required
Meta
object
Meta Data relevant to the payload
3 properties
OBInternalAccountType1Code
string
Specifies the type of account (personal or business). For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OBInternalCodeSet [here](h…
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.
Floor
string
Number that identifies the level within a building
OBCommunicationMethod
string
For a full list of enumeration values see OBExternalCommunicationMethod2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeS…
UnitNumber
string
Number that identifies the unit of a specific address .
BuildingName
string
Name of a referenced building.
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 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:…
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
Description_0
string
Specifies the description of the account type.
StreetName
string
Name of a street or thoroughfare.
OBAccount6
object
Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched: Da…
14 properties 1 required
GetAccountsAccountIdTransactionsTransactionid404Response
object
5 properties 2 required
get_account_transactions_response
object
2 properties
GetAccountsAccountIdTransactionsTransactionid401Response
object
5 properties 2 required
get_accounts_response
object
1 property 1 required
get_account_details_response
object
7 properties
get_account_balance_details_response
object
2 properties 1 required
get_account_transaction_details_response
object
4 properties 1 required
GetAccountsAccountIdTransactionsTransactionid400Response
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-accounts-api-openapi.yml Raw ↑

Other APIs Barclays publishes across the network.

Barclays Smartpay Web Payment API
Barclaycard Smartpay Connect API
Barclays Corporate Payment Initiation API
Barclays Balances and Transactions Reporting API
Barclays Account Access Consents API
Barclays Apply Product External API OAS API
Barclays Atms API
Barclays Balances API
Barclays Beneficiaries API
Barclays Branches API
Barclays Business Current Accounts API
Barclays Card Account Details Inquiry External API
Where this information came from

This is an independent, third-party profile of Barclays Accounts 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.