The identity and technical contract details declared by the specification.
Meta
object
Meta Data relevant to the payload
3 properties
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.
OBReadDataTransaction6
object
1 property
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
5 properties
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
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OBExternalPurpose1Code
string
For a full list of enumeration values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Links
object
Links relevant to the payload
5 properties
1 required
OBIntermediaryAgent
object
The intermediary agent associated with this transaction.
6 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
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…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
TransactionId
string
Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
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…
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…
OBReadTransaction6
object
3 properties
1 required
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…
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…
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…
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
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…
OBInternalTransactionMutability1Code
string
Specifies the Mutability of the Transaction record. For a full list of enumeration values refer to OBInternalTransactionMutability1Code in OBInternalCodeSet [h…
BuildingName
string
Name of a referenced building.
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
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 […
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
UnitNumber
string
Number that identifies the unit of a specific address .
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…
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
5 properties
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.
Room
string
Information that locates and identifies a room to form part of an address
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.
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
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
OBError1
object
4 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…
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 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…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
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
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
StreetName
string
Name of a street or thoroughfare.
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
OBTransaction6
object
Provides further details on an entry in the report.
32 properties
5 required
OBExtendedProprietaryBankTransactionCode
object
Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
3 properties
1 required
BuildingNumber
string
Number that identifies the position of a building on a street.
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…
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…
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.
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
Floor
string
Number that identifies the level within a building
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…
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a credit transaction.
5 properties
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
5 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…
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.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Shawbrook Bank publishes across the network.
