Barclays Account and Transactions API
Access and manage account information and transaction history through UK Open Banking standards.
Barclays Account and Transactions API is one of 30 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account, Open Banking, and Transaction. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes 29 operations across 28 paths, organized into 12 resource areas, and defines 243 schemas. It is described by OpenAPI 3.1.0, at version v4.0.
Requests are made against the base URL https://telesto.api.barclays/open-banking/v3.1.
29 operations
28 paths
243 schemas
1 DELETE27 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Barclays Account and 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 ASPSPPSUOAuth2Security— 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 29
Across 28 paths, the API surfaces 29 operations — 1 DELETE, 27 GET, 1 POST. They span 12 resource areas, including Statements, Transactions, Products, Scheduled Payments, Offers, Accounts, Balances, Account Access Consents, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Statements 5
Get Statements
GET
/accounts/{accountId}/statements
Get Statements for an AccountId
GET
/accounts/{accountId}/statements/{statementId}/transactions
Get Statement Transactions for an AccountId
GET
/accounts/{accountId}/statements/{statementId}/file
Get Statement file by StatementId for an AccountId
GET
/statements
Get Statements
GET
/accounts/{accountId}/statements/{statementId}
Get Statement by StatementId for an AccountId
Transactions 2
Get Transactions
GET
/transactions
Get Transactions
GET
/accounts/{accountId}/transactions
Get Transactions for an AccountId
Products 2
Get Products
GET
/accounts/{accountId}/product
Get Product for an AccountId
GET
/products
Get Products
Scheduled Payments 2
Get Scheduled Payments
GET
/accounts/{accountId}/scheduled-payments
Get Scheduled Payments for an AccountId
GET
/scheduled-payments
Get Scheduled Payments
Offers 2
Get Offers
GET
/accounts/{accountId}/offers
Get Offers for an AccountId
GET
/offers
Get Offers
Accounts 2
Get Accounts
GET
/accounts/{accountId}
Get an Account by AccountId
GET
/accounts
Get Accounts
Balances 2
Get Balances
GET
/balances
Get Balances
GET
/accounts/{accountId}/balances
Get Balances for an AccountId
Account Access Consents 3
Create Account Access Consents
GET
/account-access-consents/{consentId}
Get an Account Access Consent
DELETE
/account-access-consents/{consentId}
Delete an Account Access Consent
POST
/account-access-consents
Create an Account Access Consent
Standing Orders 2
Get Standing Orders
GET
/standing-orders
Get Standing Orders
GET
/accounts/{accountId}/standing-orders
Get Standing Orders for an AccountId
Beneficiaries 2
Get Beneficiaries
GET
/accounts/{accountId}/beneficiaries
Get Beneficiaries for an AccountId
GET
/beneficiaries
Get Beneficiaries
Direct Debits 2
Get Direct Debits
GET
/accounts/{accountId}/direct-debits
Get Direct Debits for an AccountId
GET
/direct-debits
Get Direct Debits
Parties 3
Get Parties
GET
/party
Get Party
GET
/accounts/{accountId}/parties
Get Parties for an AccountId
GET
/accounts/{accountId}/party
Get Party for an AccountId
Schemas 243
The contract defines 243 schemas that model the data the API accepts and returns. The most detailed are OBTransaction6 (32 properties), OBTransaction6Detail (29 properties), OBTransaction6Basic (20 properties), OBPostalAddress7 (18 properties). Each schema is shown below with its type and property counts.
Meta
object
Meta Data relevant to the payload
3 properties
OBScheduledPayment3
object
9 properties
4 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…
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…
OBExtendedProprietaryBankTransactionCode
object
Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
3 properties
1 required
OBStatement2
object
Provides further details on a statement resource.
16 properties
5 required
PhoneNumber_0
string
Collection of information that identifies a phone number, as defined by telecom services.
PhoneNumber_1
string
Collection of information that identifies a mobile phone number, as defined by telecom services.
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…
OBReadDataStatement2
object
1 property
NumberOfPayments
string
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
OBStandingOrder6
object
15 properties
1 required
PointInTime
string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or mom…
OBReadConsentResponse1
object
4 properties
2 required
OB_MinMaxType1Code
string
Min Max type
TransactionId
string
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
OBBranchAndFinancialInstitutionIdentification6_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…
5 properties
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
5 properties
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
5 properties
OBFrequencyPeriodType
string
Individual Definitions: ADHO - Adhoc YEAR - Annual DAIL - Daily INDA - Intra Day MNTH - Monthly QURT - Quarterly WEEK - Weekly
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBMandateRelatedInformation1
object
Provides further details of the mandate signed between the creditor and the debtor.
8 properties
1 required
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.
OBFileFormat
string
For a full list of enumeration values refer to ExternalDocumentFormat1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSe…
BuildingName
string
Name of a referenced building.
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
5 properties
2 required
OBInternalStatementFeeType1Code
string
Fee type, in a coded form. For a full list of values see OBInternalStatementFeeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
OBStatement2Detail
object
Provides further details on a statement resource.
16 properties
5 required
PreviousPaymentDateTime
string
Date of most recent direct debit collection. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses mus…
OBInternalAccountRole1Code
string
A party’s role with respect to the related account. For a full list refer to OBInternalAccountRole1Code in OBInternalCodeSet [here](https://github.com/OpenBank…
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBParty2
object
14 properties
1 required
OBReadTransaction6
object
3 properties
1 required
OBStandingOrder6Detail
object
15 properties
2 required
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
OBRemittanceInformation2
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
2 properties
OB_OtherCodeType1_0
object
3 properties
2 required
OBReadConsent1
object
2 properties
2 required
OBInternalStatementType1Code
string
Statement type, in a coded form. For a full list of values see OBInternalStatementType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
OB_OtherCodeType1_5
object
Other fee rate type which is not in the standard rate type list
3 properties
2 required
OB_OtherCodeType1_6
object
Other application frequencies not covered in the standard code list
3 properties
2 required
OB_OtherCodeType1_7
object
Other calculation frequency which is not available in standard code set.
3 properties
2 required
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBReadBeneficiary5
object
3 properties
1 required
OB_OtherCodeType1_8
object
Other fee rate type which is not available in the standard code set
3 properties
2 required
OB_OtherCodeType1_1
object
Other application frequencies that are not available in the standard code list
3 properties
2 required
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
OB_OtherCodeType1_2
object
Other calculation frequency which is not available in the standard code set.
3 properties
2 required
OB_OtherCodeType1_3
object
Other Fee type which is not available in the standard code set
3 properties
2 required
OB_OtherCodeType1_4
object
Other fee rate type code which is not available in the standard code set
3 properties
2 required
OBCommunicationMethod
string
For a full list of enumeration values see OBExternalCommunicationMethod2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeS…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBRate1_1
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
5 properties
2 required
OBBalanceType1Code
string
Balance type, in a coded form. For a full list of enumeration values refer to ExternalBalanceType1Code in ISOExternalCodeSet [here](https://github.com/OpenBank…
BuildingNumber
string
Number that identifies the position of a building on a street.
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OB_Rate1_0
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OB_Rate1_1
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
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…
OBReadDirectDebit2
object
3 properties
1 required
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
5 properties
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
5 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…
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…
OBReadOffer1
object
3 properties
1 required
OB_InterestFixedVariableType1Code
string
Type of interest rate, Fixed or Variable
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
OB_OverdraftFeeType1Code
string
Overdraft fee type
CountrySubDivision
string
Identifies a subdivision of a country eg, state, region, county.
OBReadStandingOrder6
object
3 properties
1 required
OBReadProduct2
object
Product details of Other Product which is not available in the standard list
3 properties
1 required
StandingOrderId
string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
OBInternalStatementFeeRateType1Code
string
This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see OBInternalStatementFeeRateType1Code in OBInternalCodeSet [her…
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBIntermediaryAgent
object
The intermediary agent associated with this transaction.
6 properties
OBInternalStatementValueType1Code
string
Statement value type, in a coded form. For a full list of values see OBInternalStatementValueType1Code in OBInternalCodeSet [here](https://github.com/OpenBanki…
OBBeneficiary5Basic
object
5 properties
OBExternalBalanceSubType1Code
string
Amount sub type, in a coded form. Default if not specified is BCUR of the account.
OBInternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested. For a full list of values see OBInternalStatementInterestFrequency1Code in OBInternalCodeSet [here](https://github.…
OBInternalStatementDateTimeType1Code
string
Date time type, in a coded form. For a full list of values see OBInternalStatementDateTimeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingU…
OB_Amount1_1
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
OB_Amount1_0
string
Cap amount charged for a fee/charge
OBFrequency6
object
Regularity with which credit transfer instructions are to be created and processed
3 properties
1 required
BeneficiaryId
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
OBFrequency2
string
For a full list of enumeration values refer to OBFrequency2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSets)
OBInternalStatementAmountType1Code
string
Amount type, in a coded form.
OBStandingOrder6Basic
object
13 properties
1 required
OBAccount6Detail
object
Unambiguous identification of the account to which credit and debit entries are made.
14 properties
2 required
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.
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
OB_Amount1_4
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
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…
OB_Amount1_3
string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_Amount1_2
string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
OB_OtherFeeChargeDetailType
object
Other Fee/charge type which is not available in the standard code set
4 properties
3 required
OBReferredDocumentInformation
object
5 properties
Time
string
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 transact…
OBError1
object
4 properties
1 required
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
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
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 resp…
OBScheduledPayment3Basic
object
7 properties
4 required
OBActiveOrHistoricCurrencyAndAmount_0
object
The amount of the most recent direct debit collection.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_1
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
OBActiveOrHistoricCurrencyAndAmount_2
object
The amount of the first Standing Order
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_3
object
The amount of the next Standing Order.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_4
object
The amount of the final Standing Order
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement benefit type.
2 properties
2 required
OBReadParty3
object
3 properties
1 required
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties
2 required
OBReadParty2
object
3 properties
1 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
ExternalMandateStatus1Code
string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISOExternalCodeset [her…
OBActiveOrHistoricCurrencyAndAmount_8
object
Amount of money associated with the amount type.
3 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
FinalPaymentDateTime
string
The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. Al…
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
CreationDateTime
string
Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
NextPaymentDateTime
string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All…
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…
5 properties
2 required
OBScheduledPayment3Detail
object
9 properties
5 required
OB_FeeType1Code
string
Fee/Charge Type
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
OBExternalPurpose1Code
string
For a full list of enumeration values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBStatusReason
object
3 properties
Name_4
string
Long name associated with the code
OBInternalLegalStructureType1Code
string
Legal standing of the party. For a full list refer to OBInternalLegalStructureType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalIn…
OBInternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account. For a full list of values see OBInternalStatementFeeFrequency1Code in OBInternalCodeSet [here](https://github…
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…
Description_2
string
Description that may be available for the statement interest.
OBInternalTransactionMutability1Code
string
Specifies the Mutability of the Transaction record. For a full list of enumeration values refer to OBInternalTransactionMutability1Code in OBInternalCodeSet [h…
Description_1
string
Description that may be available for the statement fee.
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.
DateTime
string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in response…
Description_0
string
Specifies the description of the account type.
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…
Description_3
string
Description to describe the purpose of the code
FullLegalName
string
The full legal name of the party.
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.
OBBeneficiary5Detail
object
7 properties
1 required
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…
Rate
string
Rate associated with the statement rate type.
MandateIdentification
string
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
OBInternalScheduleType1Code
string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to OBInternalScheduleType1Code in OBInternalCodeSet [here](htt…
OBInternalStatementInterestRateType1Code
string
This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross).
OBInternalStatementRateType1Code
string
Statement rate type, in a coded form. For a full list of values see OBInternalStatementRateType1Code in OBInternalCodeSet [here](https://github.com/OpenBanking…
EmailAddress
string
Address for electronic mail (e-mail).
OBBCAData1
object
4 properties
StatementId
string
Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable.
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
Identification_4
string
Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
UnitNumber
string
Number that identifies the unit of a specific address .
FirstPaymentDateTime
string
The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. Al…
Name_3
string
Name by which a party is known and which is usually used to identify that party.
Name_2
string
Name of Service User.
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
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…
OBPartyRelationships1
object
The Party's relationships with other resources.
1 property
OB_FeeFrequency1Code_1
string
How often is the overdraft fee/charge calculated for the account.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OB_FeeFrequency1Code_2
string
How frequently the fee/charge is applied to the account
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…
OB_FeeFrequency1Code_0
string
Frequency at which the overdraft charge is applied to the account
OBPCAData1
object
4 properties
OBRisk2
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction. For a full list of enumeration values refer to OBInternalCardSchemeType1Code in OBInte…
4 properties
1 required
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. For a full list of values see OBInternalCreditDebitCode in OBInternalCodeSet [here](https://github.com/Ope…
OB_FeeFrequency1Code_3
string
How frequently the fee/charge is calculated
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry. For a full list of enumeration values refer to OBInternalCreditDebitCode in OBInternalCodeSet […
OB_FeeFrequency1Code_4
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OBExternalMandateClassification1Code
string
Type of mandate instruction. For a full list of values see OBExternalClassification1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
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…
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. For a full list of enumeration values…
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…
OBRemittanceInformationStructured
object
7 properties
PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
Model
object
1 property
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBReadStatement2
object
3 properties
1 required
OBStatement2Basic
object
Provides further details on a statement resource.
15 properties
5 required
StreetName
string
Name of a street or thoroughfare.
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code in ISOExtern…
OBAccount6Basic
object
Unambiguous identification of the account to which credit and debit entries are made.
11 properties
1 required
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
DebtorReference
string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
OBFrequency6Code
string
For a full list of values see OBFrequency6Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
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…
OBInternalAccountStatus1Code
string
Specifies the status of account resource in code form. For a full list of enumeration values refer to OBInternalAccountStatus1Code in OBInternalCodeSet [here](…
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
Frequency_1
string
Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days…
OB_Period1Code
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
ExternalEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer. For a full list of enumeration values refer to ExternalEntryStatus1Code in ISOExternalCodeS…
OBActiveOrHistoricCurrencyAndAmount_11
object
The amount of the last (most recent) Standing Order instruction.
2 properties
2 required
OBReadScheduledPayment3
object
3 properties
1 required
OBTransaction6Basic
object
Provides further details on an entry in the report.
20 properties
5 required
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For more information and a full list of values see Ex…
Number_1
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
Number_0
integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the…
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group) For a full list of enumeration values refer to OBExternalCashAccountType1Code OBInternalCodeSet [here]…
OBReadAccount6
object
3 properties
1 required
OB_InterestCalculationMethod1Code
string
Methods of calculating interest
Value
string
Value associated with the statement value type.
OBBeneficiary5
object
7 properties
OBReadDataTransaction6
object
1 property
File
object
OBInternalStatementBenefitType1Code
string
Benefit type, in a coded form. For a full list of values see OBInternalStatementBenefitType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/E…
OB_FeeCategory1Code
string
Categorisation of fees and charges into standard categories.
OBTransaction6Detail
object
Provides further details on an entry in the report.
29 properties
5 required
OB_CodeMnemonic
string
The four letter Mnemonic used within an XML file to identify a code
DirectDebitId
string
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
StatementFrequencyAndFormat
array
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
OB_InterestRateType1Code_1
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
EndDateTime
string
Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in response…
OBInternalBeneficiaryType1Code
string
Specifies the Beneficiary Type.
LastPaymentDateTime
string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time f…
CountryCode
string
Nation with its own government, occupying a particular territory.
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
Floor
string
Number that identifies the level within a building
OBInternalPartyType1Code
string
Party type, in a coded form. For a full list see OBInternalPartyType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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…
Date
string
Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date format. An example is below: 2017-04-05
OBInternalStatementInterestType1Code
string
Interest amount type, in a coded form. For a full list of values see OBInternalStatementInterestType1Code in OBInternalCodeSet [here](https://github.com/OpenBa…
OB_InterestRateType1Code_0
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
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…
PartyNumber
string
Number assigned by an agent to identify its customer.
StartDateTime
string
Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respon…
OBTransaction6
object
Provides further details on an entry in the report.
32 properties
5 required
OBReadBalance1
object
3 properties
1 required
Links
object
Links relevant to the payload
5 properties
1 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:…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Barclays 12
Other APIs Barclays publishes across the network.
Barclays Smartpay Web Payment API
Barclays Bank Ireland Confirmation of Funds API
Barclays Bank Ireland Account Information API
Barclays Bank Ireland Payment Initiation API
Barclays Confirmation of Funds API
Barclays Dynamic Client Registration API
Barclays Event Notification API
Barclays Payment Initiation API
Barclays ATM Locator API
Barclays Branch Locator API
Barclays FCA Service Metrics API
Barclays Product Details API
#Account#Open Banking#Transaction
Where this information came from
This is an independent, third-party profile of Barclays Account and 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.