Hampden & Co Account & Transaction Information API
OBIE Read/Write Account Information Service (AIS) - accounts, balances, transactions, beneficiaries, standing orders, direct debits, statements, and parties - as a FAPI-secured PSD2 dedicated interface. The harvested OpenAPI is the shared OBIE Read/Write standard (v4.0.1), not a Hampden-proprietary contract; production access requires TPP onboarding with eIDAS/OBIE certificates.
Hampden & Co Account & Transaction Information API is one of 4 APIs that Hampden & Co publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account Information and AIS. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 29 operations across 28 paths, organized into 12 resource areas, and defines 243 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.
Requests are made against a single base URL, /open-banking/v4.0/aisp.
29 operations
28 paths
243 schemas
1 DELETE27 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Hampden & Co Account & Transaction Information 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 Account Access Consents, Accounts, Balances, Beneficiaries, Direct Debits, Offers, Parties, Products, and 4 more. Each is listed below with its method, path, parameters, and response codes.
Account Access Consents 3
POST
/account-access-consents
Create an Account Access Consent
GET
/account-access-consents/{ConsentId}
Get an Account Access Consent
DELETE
/account-access-consents/{ConsentId}
Delete an Account Access Consent
Accounts 2
GET
/accounts
Get Accounts
GET
/accounts/{AccountId}
Get an Account by AccountId
Balances 2
GET
/accounts/{AccountId}/balances
Get Balances for an AccountId
GET
/balances
Get Balances
Beneficiaries 2
GET
/accounts/{AccountId}/beneficiaries
Get Beneficiaries for an AccountId
GET
/beneficiaries
Get Beneficiaries
Direct Debits 2
GET
/accounts/{AccountId}/direct-debits
Get Direct Debits for an AccountId
GET
/direct-debits
Get Direct Debits
Offers 2
GET
/accounts/{AccountId}/offers
Get Offers for an AccountId
GET
/offers
Get Offers
Parties 3
GET
/accounts/{AccountId}/parties
Get Parties for an AccountId
GET
/accounts/{AccountId}/party
Get Party for an AccountId
GET
/party
Get Party
Products 2
GET
/accounts/{AccountId}/product
Get Product for an AccountId
GET
/products
Get Products
Scheduled Payments 2
GET
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments for an AccountId
GET
/scheduled-payments
Get Scheduled Payments
Standing Orders 2
GET
/accounts/{AccountId}/standing-orders
Get Standing Orders for an AccountId
GET
/standing-orders
Get Standing Orders
Statements 5
GET
/accounts/{AccountId}/statements
Get Statements for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}
Get Statement by StatementId for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}/file
Get Statement file by StatementId for an AccountId
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Statement Transactions for an AccountId
GET
/statements
Get Statements
Transactions 2
GET
/accounts/{AccountId}/transactions
Get Transactions for an AccountId
GET
/transactions
Get Transactions
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.
OBIntermediaryAgent
object
The intermediary agent associated with this transaction.
6 properties
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
OBReferredDocumentInformation
object
5 properties
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
OBRemittanceInformationStructured
object
7 properties
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OBFrequency6
object
Regularity with which credit transfer instructions are to be created and processed
3 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…
OBFrequency6Code
string
For a full list of values see OBFrequency6Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 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…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
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…
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…
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
BeneficiaryId
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
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…
BuildingName
string
Name of a referenced building.
BuildingNumber
string
Number that identifies the position of a building on a street.
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…
CountryCode
string
Nation with its own government, occupying a particular territory.
CountrySubDivision
string
Identifies a subdivision of a country eg, state, region, county.
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…
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
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…
DebtorReference
string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
Description_0
string
Specifies the description of the account type.
Description_1
string
Description that may be available for the statement fee.
Description_2
string
Description that may be available for the statement interest.
Description_3
string
Description to describe the purpose of the code
DirectDebitId
string
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
EmailAddress
string
Address for electronic mail (e-mail).
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…
File
object
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…
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…
Floor
string
Number that identifies the level within a building
Frequency_1
string
Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days…
FullLegalName
string
The full legal name of the party.
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:…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
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.
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.
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…
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…
Links
object
Links relevant to the payload
5 properties
1 required
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.
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…
Meta
object
Meta Data relevant to the payload
3 properties
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…
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
Name_2
string
Name of Service User.
Name_3
string
Name by which a party is known and which is usually used to identify that party.
Name_4
string
Long name associated with the code
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…
Nickname
string
The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
NumberOfPayments
string
Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.
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…
Number_1
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
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
OBAccount6Basic
object
Unambiguous identification of the account to which credit and debit entries are made.
11 properties
1 required
OBAccount6Detail
object
Unambiguous identification of the account to which credit and debit entries are made.
14 properties
2 required
OBInternalAccountStatus1Code
string
Specifies the status of account resource in code form. For a full list of enumeration values refer to OBInternalAccountStatus1Code in OBInternalCodeSet [here](…
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_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_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_11
object
The amount of the last (most recent) Standing Order instruction.
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
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
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
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…
OBBCAData1
object
4 properties
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…
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
OBBeneficiary5
object
7 properties
OBBeneficiary5Basic
object
5 properties
OBBeneficiary5Detail
object
7 properties
1 required
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
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
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
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
5 properties
2 required
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
5 properties
2 required
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
5 properties
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
5 properties
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…
OBExternalMandateClassification1Code
string
Type of mandate instruction. For a full list of values see OBExternalClassification1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
OBCommunicationMethod
string
For a full list of enumeration values see OBExternalCommunicationMethod2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeS…
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…
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 […
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…
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 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…
OBInternalTransactionMutability1Code
string
Specifies the Mutability of the Transaction record. For a full list of enumeration values refer to OBInternalTransactionMutability1Code in OBInternalCodeSet [h…
OBError1
object
4 properties
1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
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…
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…
OBExternalAccountSubType1Code
string
Specifies the sub type of account (product family group) For a full list of enumeration values refer to OBExternalCashAccountType1Code OBInternalCodeSet [here]…
OBInternalAccountType1Code
string
Specifies the type of account (personal or business). For a full list of enumeration values refer to 'OBInternalAccountType1Code' in OBInternalCodeSet [here](h…
OBExternalBalanceSubType1Code
string
Amount sub type, in a coded form. Default if not specified is BCUR of 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…
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…
OBInternalLegalStructureType1Code
string
Legal standing of the party. For a full list refer to OBInternalLegalStructureType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalIn…
OBInternalPartyType1Code
string
Party type, in a coded form. For a full list see OBInternalPartyType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBExternalPurpose1Code
string
For a full list of enumeration values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBInternalScheduleType1Code
string
Specifies the scheduled payment date type requested. For a full list of enumeration values refer to OBInternalScheduleType1Code in OBInternalCodeSet [here](htt…
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…
OBInternalStatementAmountType1Code
string
Amount type, in a coded form.
OBInternalStatementBenefitType1Code
string
Benefit type, in a coded form. For a full list of values see OBInternalStatementBenefitType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/E…
OBInternalStatementDateTimeType1Code
string
Date time type, in a coded form. For a full list of values see OBInternalStatementDateTimeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingU…
OBInternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account. For a full list of values see OBInternalStatementFeeFrequency1Code in OBInternalCodeSet [here](https://github…
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…
OBInternalStatementFeeType1Code
string
Fee type, in a coded form. For a full list of values see OBInternalStatementFeeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
OBInternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested. For a full list of values see OBInternalStatementInterestFrequency1Code in OBInternalCodeSet [here](https://github.…
OBInternalStatementInterestRateType1Code
string
This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross).
OBInternalStatementInterestType1Code
string
Interest amount type, in a coded form. For a full list of values see OBInternalStatementInterestType1Code in OBInternalCodeSet [here](https://github.com/OpenBa…
OBInternalStatementRateType1Code
string
Statement rate type, in a coded form. For a full list of values see OBInternalStatementRateType1Code in OBInternalCodeSet [here](https://github.com/OpenBanking…
OBInternalStatementType1Code
string
Statement type, in a coded form. For a full list of values see OBInternalStatementType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
OBInternalStatementValueType1Code
string
Statement value type, in a coded form. For a full list of values see OBInternalStatementValueType1Code in OBInternalCodeSet [here](https://github.com/OpenBanki…
OBFrequency2
string
For a full list of enumeration values refer to OBFrequency2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSets)
OBFrequencyPeriodType
string
Individual Definitions: ADHO - Adhoc YEAR - Annual DAIL - Daily INDA - Intra Day MNTH - Monthly QURT - Quarterly WEEK - Weekly
OBFileFormat
string
For a full list of enumeration values refer to ExternalDocumentFormat1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalinternalCodeSe…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBMandateRelatedInformation1
object
Provides further details of the mandate signed between the creditor and the debtor.
8 properties
1 required
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBPCAData1
object
4 properties
OBParty2
object
14 properties
1 required
OBPartyRelationships1
object
The Party's relationships with other resources.
1 property
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
OBRate1_1
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
OBReadAccount6
object
3 properties
1 required
OBReadBalance1
object
3 properties
1 required
OBReadBeneficiary5
object
3 properties
1 required
OBReadConsent1
object
2 properties
2 required
OBReadConsentResponse1
object
4 properties
2 required
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form.
OBReadDataStatement2
object
1 property
OBReadDataTransaction6
object
1 property
OBReadDirectDebit2
object
3 properties
1 required
OBReadOffer1
object
3 properties
1 required
OBReadParty2
object
3 properties
1 required
OBReadParty3
object
3 properties
1 required
OBReadProduct2
object
Product details of Other Product which is not available in the standard list
3 properties
1 required
OBReadScheduledPayment3
object
3 properties
1 required
OBReadStandingOrder6
object
3 properties
1 required
OBReadStatement2
object
3 properties
1 required
OBReadTransaction6
object
3 properties
1 required
OBScheduledPayment3
object
9 properties
4 required
OBScheduledPayment3Basic
object
7 properties
4 required
OBScheduledPayment3Detail
object
9 properties
5 required
OBStandingOrder6
object
15 properties
1 required
OBStandingOrder6Basic
object
13 properties
1 required
OBStandingOrder6Detail
object
15 properties
2 required
OBStatement2
object
Provides further details on a statement resource.
16 properties
5 required
OBStatement2Basic
object
Provides further details on a statement resource.
15 properties
5 required
OBStatement2Detail
object
Provides further details on a statement resource.
16 properties
5 required
OBStatusReason
object
3 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBTransaction6
object
Provides further details on an entry in the report.
32 properties
5 required
OBTransaction6Basic
object
Provides further details on an entry in the report.
20 properties
5 required
OBTransaction6Detail
object
Provides further details on an entry in the report.
29 properties
5 required
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
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
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.
OB_Amount1_0
string
Cap amount charged for a fee/charge
OB_Amount1_1
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
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_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_4
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_CodeMnemonic
string
The four letter Mnemonic used within an XML file to identify a code
OB_FeeCategory1Code
string
Categorisation of fees and charges into standard categories.
OB_FeeFrequency1Code_0
string
Frequency at which the overdraft charge is applied to the account
OB_FeeFrequency1Code_1
string
How often is the overdraft fee/charge calculated for the account.
OB_FeeFrequency1Code_2
string
How frequently the fee/charge is applied to the account
OB_FeeFrequency1Code_3
string
How frequently the fee/charge is calculated
OB_FeeFrequency1Code_4
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OB_FeeType1Code
string
Fee/Charge Type
OB_InterestCalculationMethod1Code
string
Methods of calculating interest
OB_InterestFixedVariableType1Code
string
Type of interest rate, Fixed or Variable
OB_InterestRateType1Code_0
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_InterestRateType1Code_1
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
OB_MinMaxType1Code
string
Min Max type
OB_OtherCodeType1_0
object
3 properties
2 required
OB_OtherCodeType1_1
object
Other application frequencies that are not available in the standard code list
3 properties
2 required
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
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
OB_OtherCodeType1_8
object
Other fee rate type which is not available in the standard code set
3 properties
2 required
OB_OtherFeeChargeDetailType
object
Other Fee/charge type which is not available in the standard code set
4 properties
3 required
OB_OverdraftFeeType1Code
string
Overdraft fee type
OB_Period1Code
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OB_Rate1_0
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_Rate1_1
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
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…
PartyId
string
A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
PartyNumber
string
Number assigned by an agent to identify its customer.
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.
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.
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.
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…
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
Rate
string
Rate associated with the statement rate type.
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…
Room
string
Information that locates and identifies a room to form part of an address
OBExtendedProprietaryBankTransactionCode
object
Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
3 properties
1 required
OBInternalBeneficiaryType1Code
string
Specifies the Beneficiary Type.
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…
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to 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…
StandingOrderId
string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
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…
StatementFrequencyAndFormat
array
StatementId
string
Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
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…
StreetName
string
Name of a street or thoroughfare.
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…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
TransactionId
string
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
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.
UnitNumber
string
Number that identifies the unit of a specific address .
Value
string
Value associated with the statement value type.
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…
Model
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hampden & Co 3
Other APIs Hampden & Co publishes across the network.
Hampden & Co Open Data API
Hampden & Co Payment Initiation API
Hampden & Co Confirmation of Funds API
#Account Information#AIS