The identity and technical contract details declared by the specification.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBReadStatement2
object
3 properties
1 required
Rate
string
Rate associated with the statement rate type.
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
Room
string
Information that locates and identifies a room to form part of an address
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
5 properties
Floor
string
Number that identifies the level within a building
OBInternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account. For a full list of values see OBInternalStatementFeeFrequency1Code in OBInternalCodeSet [here](https://github…
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
OBInternalStatementFeeType1Code
string
Fee type, in a coded form. For a full list of values see OBInternalStatementFeeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
5 properties
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 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…
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…
BuildingNumber
string
Number that identifies the position of a building on a street.
OBIntermediaryAgent
object
The intermediary agent associated with this transaction.
6 properties
Meta
object
Meta Data relevant to the payload
3 properties
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
OBInternalStatementRateType1Code
string
Statement rate type, in a coded form. For a full list of values see OBInternalStatementRateType1Code in OBInternalCodeSet [here](https://github.com/OpenBanking…
OBInternalStatementInterestType1Code
string
Interest amount type, in a coded form. For a full list of values see OBInternalStatementInterestType1Code in OBInternalCodeSet [here](https://github.com/OpenBa…
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
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…
TransactionId
string
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
OBInternalStatementBenefitType1Code
string
Benefit type, in a coded form. For a full list of values see OBInternalStatementBenefitType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/E…
OBStatement2
object
Provides further details on a statement resource.
16 properties
5 required
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
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…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBInternalStatementDateTimeType1Code
string
Date time type, in a coded form. For a full list of values see OBInternalStatementDateTimeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingU…
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
5 properties
TransactionReference
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
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…
OBInternalStatementInterestRateType1Code
string
This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross).
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…
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction. For a full list of enumeration values refer to OBInternalCardSchemeType1Code in OBInte…
4 properties
1 required
Description_2
string
Description that may be available for the statement interest.
Links
object
Links relevant to the payload
5 properties
1 required
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…
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties
2 required
OBReadTransaction6
object
3 properties
1 required
Value
string
Value associated with the statement value type.
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
OBError1
object
4 properties
1 required
StreetName
string
Name of a street or thoroughfare.
OBInternalStatementType1Code
string
Statement type, in a coded form. For a full list of values see OBInternalStatementType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
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…
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
OBInternalStatementAmountType1Code
string
Amount type, in a coded form.
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
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.
BuildingName
string
Name of a referenced building.
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…
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:…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBExtendedProprietaryBankTransactionCode
object
Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
3 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
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBInternalTransactionMutability1Code
string
Specifies the Mutability of the Transaction record. For a full list of enumeration values refer to OBInternalTransactionMutability1Code in OBInternalCodeSet [h…
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
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.
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…
OBInternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested. For a full list of values see OBInternalStatementInterestFrequency1Code in OBInternalCodeSet [here](https://github.…
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement benefit type.
2 properties
2 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…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
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.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
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…
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
5 properties
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
UnitNumber
string
Number that identifies the unit of a specific address .
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…
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…
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…
OBReadDataStatement2
object
1 property
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…
OBReadDataTransaction6
object
1 property
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…
OBTransaction6
object
Provides further details on an entry in the report.
32 properties
5 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…
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…
StatementId
string
Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable.
Description_1
string
Description that may be available for the statement fee.
OBExternalPurpose1Code
string
For a full list of enumeration values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
OBRate1_1
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
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…
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 […
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…
OBInternalStatementValueType1Code
string
Statement value type, in a coded form. For a full list of values see OBInternalStatementValueType1Code in OBInternalCodeSet [here](https://github.com/OpenBanki…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Aldermore Bank publishes across the network.