C. Hoare & Co. Account and Transaction Information API
OBIE Read/Write Account & Transaction Information (AIS) API — lets onboarded, consented AISP third-party providers retrieve C. Hoare & Co. account, balance, transaction, beneficiary, standing order, direct debit, product, and party data. Conformant to the OBIE v3.1 Read/Write standard; FAPI-secured (OAuth2/OIDC + PSD2 SCA + mTLS).
C. Hoare & Co. Account and Transaction Information API is one of 3 APIs that C. Hoare & Co. publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account Information, Transactions, Open Banking, and AISP. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 28 operations across 27 paths, organized into 12 resource areas, and defines 97 schemas. It is described by OpenAPI 3.0.1, at version v3.1.0.
Requests are made against the base URL https://api.hoaresbank.co.uk/open-banking/v3.1/aisp.
28 operations
27 paths
97 schemas
1 DELETE26 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
C. Hoare & Co. Account and Transaction Information API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.
It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope.
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 PSUTPPOAuth2Security— TPP client credential authorisation flow with the ASPSP
Paths & Operations 28
Across 27 paths, the API surfaces 28 operations — 1 DELETE, 26 GET, 1 POST. They span 12 resource areas, including Account Access, Accounts, Balances, Beneficiaries, Direct Debits, Offers, Partys, Products, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Account Access 3
POST
/account-access-consents
Create Account Access Consents
GET
/account-access-consents/{ConsentId}
Get Account Access Consents
DELETE
/account-access-consents/{ConsentId}
Delete Account Access Consents
Accounts 2
GET
/accounts
Get Accounts
GET
/accounts/{AccountId}
Get Accounts
Balances 2
GET
/accounts/{AccountId}/balances
Get Balances
GET
/balances
Get Balances
Beneficiaries 2
GET
/accounts/{AccountId}/beneficiaries
Get Beneficiaries
GET
/beneficiaries
Get Beneficiaries
Direct Debits 2
GET
/accounts/{AccountId}/direct-debits
Get Direct Debits
GET
/direct-debits
Get Direct Debits
Offers 2
GET
/accounts/{AccountId}/offers
Get Offers
GET
/offers
Get Offers
Partys 2
GET
/accounts/{AccountId}/party
Get Party
GET
/party
Get Party
Products 2
GET
/accounts/{AccountId}/product
Get Products
GET
/products
Get Products
Scheduled Payments 2
GET
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments
GET
/scheduled-payments
Get Scheduled Payments
Standing Orders 2
GET
/accounts/{AccountId}/standing-orders
Get Standing Orders
GET
/standing-orders
Get Standing Orders
Statements 5
GET
/accounts/{AccountId}/statements
Get Statements
GET
/accounts/{AccountId}/statements/{StatementId}
Get Statements
GET
/accounts/{AccountId}/statements/{StatementId}/file
Get Statements
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Transactions
GET
/statements
Get Statements
Transactions 2
GET
/accounts/{AccountId}/transactions
Get Transactions
GET
/transactions
Get Transactions
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are OBTransaction4Detail (23 properties), OBTransaction4Basic (16 properties), OBStatement1Detail (15 properties), OBStatement1Basic (14 properties). Each schema is shown below with its type and property counts.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBAccount3
OBAccount3Basic
object
Unambiguous identification of the account to which credit and debit entries are made.
6 properties
4 required
OBAccount3Detail
object
Unambiguous identification of the account to which credit and debit entries are made.
8 properties
5 required
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.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money of the cash balance after a transaction entry is applied to the account..
2 properties
2 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBBCAData1
object
4 properties
OBBalanceType1Code
string
Balance type, in a coded form.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBBeneficiary3
OBBeneficiary3Basic
object
3 properties
OBBeneficiary3Detail
object
5 properties
1 required
OBCashBalance1
object
Set of elements used to define the balance details.
6 properties
5 required
OBCreditDebitCode
string
OBCreditLine1
object
Set of elements used to provide details on the credit line.
3 properties
1 required
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
OBDirectDebit1
object
Account to or from which a cash entry is made.
7 properties
3 required
OBEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer.
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group).
OBExternalAccountType1Code
string
Specifies the type of account (personal or business).
OBExternalCardAuthorisationType1Code
string
The card authorisation type.
OBExternalCardSchemeType1Code
string
Name of the card scheme.
OBExternalDirectDebitStatus1Code
string
Specifies the status of the direct debit in code form.
OBExternalLimitType1Code
string
Limit type, in a coded form.
OBExternalOfferType1Code
string
Offer type, in a coded form.
OBExternalPartyType1Code
string
Party type, in a coded form.
OBExternalPermissions1Code
string
Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the…
OBExternalProductType1Code
string
Descriptive code for the product category. If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description.
OBExternalRequestStatus1Code
string
Specifies the status of consent resource in code form.
OBExternalScheduleType1Code
string
Specifies the scheduled payment date type requested
OBExternalStandingOrderStatus1Code
string
Specifies the status of the standing order in code form.
OBExternalStatementType1Code
string
Statement type, in a coded form.
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBOffer1
object
12 properties
1 required
OBPCAData1
object
4 properties
OBParty1
object
8 properties
1 required
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
OBPostalAddress8
object
Postal address of a party.
8 properties
1 required
OBProduct2
object
9 properties
1 required
OBReadAccount3
object
3 properties
3 required
OBReadBalance1
object
3 properties
3 required
OBReadBeneficiary3
object
3 properties
3 required
OBReadConsent1
object
2 properties
2 required
OBReadConsentResponse1
object
4 properties
4 required
OBReadData1
object
4 properties
1 required
OBReadDirectDebit1
object
3 properties
3 required
OBReadOffer1
object
3 properties
3 required
OBReadParty1
object
3 properties
3 required
OBReadProduct2
object
3 properties
3 required
OBReadScheduledPayment2
object
3 properties
3 required
OBReadStandingOrder4
object
3 properties
3 required
OBReadStatement1
object
3 properties
3 required
OBReadTransaction4
object
3 properties
3 required
OBScheduledPayment2
OBScheduledPayment2Basic
object
6 properties
4 required
OBScheduledPayment2Detail
object
8 properties
5 required
OBStandingOrder4
OBStandingOrder4Basic
object
12 properties
2 required
OBStandingOrder4Detail
object
14 properties
3 required
OBStatement1
OBStatement1Basic
object
Provides further details on a statement resource.
14 properties
5 required
OBStatement1Detail
object
Provides further details on a statement resource.
15 properties
5 required
OBStatementAmount1
object
Set of elements used to provide details of a generic amount for the statement resource.
3 properties
3 required
OBStatementBenefit1
object
Set of elements used to provide details of a benefit or reward amount for the statement resource.
2 properties
2 required
OBStatementDateTime1
object
Set of elements used to provide details of a generic date time for the statement resource.
2 properties
2 required
OBStatementFee1
object
Set of elements used to provide details of a fee for the statement resource.
3 properties
3 required
OBStatementInterest1
object
Set of elements used to provide details of a generic interest amount related to the statement resource.
3 properties
3 required
OBStatementRate1
object
Set of elements used to provide details of a generic rate related to the statement resource.
2 properties
2 required
OBStatementValue1
object
Set of elements used to provide details of a generic number value related to the statement resource.
2 properties
2 required
OBTransaction4
OBTransaction4Basic
object
Provides further details on an entry in the report.
16 properties
5 required
OBTransaction4Detail
object
Provides further details on an entry in the report.
23 properties
5 required
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction.
4 properties
1 required
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
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
OBOtherProductType1
object
This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for A…
2 properties
2 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBBranchAndFinancialInstitutionIdentification5
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…
2 properties
2 required
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBCashAccount5
object
Provides the details to identify the beneficiary account.
4 properties
2 required
OBCashAccount6
object
Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
4 properties
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBExternalStatementBenefitType1Code
string
Benefit type, in a coded form.
OBExternalStatementFeeType1Code
string
Fee type, in a coded form.
OBExternalStatementInterestType1Code
string
Interest amount type, in a coded form.
OBExternalStatementDateTimeType1Code
string
Date time type, in a coded form.
OBExternalStatementRateType1Code
string
Statement rate type, in a coded form.
OBExternalStatementValueType1Code
string
Statement value type, in a coded form.
OBExternalStatementAmountType1Code
string
Amount type, in a coded form.
OBBranchAndFinancialInstitutionIdentification6
object
Financial institution servicing an account for the debtor.
4 properties
OBError1
object
4 properties
2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 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:…
Links
object
Links relevant to the payload
5 properties
1 required
Meta
object
Meta Data relevant to the payload
3 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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from C. Hoare & Co. 2
Other APIs C. Hoare & Co. publishes across the network.
C. Hoare & Co. Payment Initiation API
C. Hoare & Co. Dynamic Client Registration API
#Account Information#Transactions#Open Banking#AISP