openapi: 3.2.0 info: title: Account and Transaction API Specification Statements API description: 'Swagger for Account and Transaction API Specification. **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field. ' termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: 4.0.1 servers: - url: /open-banking/v4.0/aisp tags: - name: Statements paths: /accounts/{AccountId}/statements: get: tags: - Statements summary: Get Statements for an AccountId description: Enables an AISP to retrieve statement information for a specific PSU account. operationId: GetAccountsAccountIdStatements parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/FromStatementDateTimeParam' - $ref: '#/components/parameters/ToStatementDateTimeParam' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/statements/{StatementId}: get: tags: - Statements summary: Get Statement by StatementId for an AccountId description: Enables an AISP to retrieve the statement information resource for a specific statement. operationId: GetAccountsAccountIdStatementsStatementId parameters: - $ref: '#/components/parameters/StatementId' - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/statements/{StatementId}/file: get: tags: - Statements summary: Get Statement file by StatementId for an AccountId description: Enables an AISP to retrieve a non-json representation of a specific statement. operationId: GetAccountsAccountIdStatementsStatementIdFile parameters: - $ref: '#/components/parameters/StatementId' - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdFileRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/statements/{StatementId}/transactions: get: tags: - Statements summary: Get Statement Transactions for an AccountId description: Enables an AISP to retrieve transactions that appear on a selected statement for a specific PSU account. operationId: GetAccountsAccountIdStatementsStatementIdTransactions parameters: - $ref: '#/components/parameters/StatementId' - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - accounts /statements: get: tags: - Statements summary: Get Statements description: Enables an AISP to retrieve statement information for account(s) that the PSU has consented to. operationId: GetStatements parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/FromStatementDateTimeParam' - $ref: '#/components/parameters/ToStatementDateTimeParam' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200StatementsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - accounts components: schemas: UnitNumber: description: Number that identifies the unit of a specific address . type: string example: A88 minLength: 1 maxLength: 16 OBInternalStatementFeeType1Code: description: Fee type, in a coded form. For a full list of values see `OBInternalStatementFeeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.Annual x-namespaced-enum: - UK.OBIE.Annual - UK.OBIE.BalanceTransfer - UK.OBIE.CashAdvance - UK.OBIE.CashTransaction - UK.OBIE.ForeignCashTransaction - UK.OBIE.ForeignTransaction - UK.OBIE.Gambling - UK.OBIE.LatePayment - UK.OBIE.MoneyTransfer - UK.OBIE.Monthly - UK.OBIE.Overlimit - UK.OBIE.PostalOrder - UK.OBIE.PrizeEntry - UK.OBIE.StatementCopy - UK.OBIE.Total - UK.OBIE.InstalmentPlan - UK.OBIE.ReturnedPayment OBInternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet OBExtendedProprietaryBankTransactionCode: type: object description: Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction required: - Code properties: Code: type: string description: Proprietary bank transaction code to identify the underlying transaction. minLength: 1 maxLength: 35 Issuer: type: string description: Identification of the issuer of the proprietary bank transaction code. minLength: 1 maxLength: 35 Description: type: string description: Description of the code and its usage on the ASPSP channel minLength: 1 maxLength: 500 OBCashAccount6_0: type: object description: Unambiguous identification of the account of the creditor, in the case of a debit transaction. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' OBProxy1: description: Specifies an alternate assumed name for the identification of the account. type: object required: - Identification - Code properties: Identification: description: Identification used to indicate the account identification under another specified name. type: string example: '2360549017905188' minLength: 1 maxLength: 2048 Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. minLength: 1 maxLength: 35 OBInternalStatementAmountType1Code: description: Amount type, in a coded form. type: string example: UK.OBIE.CreditLimit x-namespaced-enum: - UK.OBIE.ArrearsClosingBalance - UK.OBIE.AvailableBalance - UK.OBIE.AverageBalanceWhenInCredit - UK.OBIE.AverageBalanceWhenInDebit - UK.OBIE.AverageDailyBalance - UK.OBIE.BalanceTransferClosingBalance - UK.OBIE.CashClosingBalance - UK.OBIE.ClosingBalance - UK.OBIE.CreditLimit - UK.OBIE.CurrentPayment - UK.OBIE.DirectDebitPaymentDue - UK.OBIE.FSCSInsurance - UK.OBIE.MinimumPaymentDue - UK.OBIE.PendingTransactionsBalance - UK.OBIE.PreviousClosingBalance - UK.OBIE.PreviousPayment - UK.OBIE.PurchaseClosingBalance - UK.OBIE.StartingBalance - UK.OBIE.TotalAdjustments - UK.OBIE.TotalCashAdvances - UK.OBIE.TotalCharges - UK.OBIE.TotalCredits - UK.OBIE.TotalDebits - UK.OBIE.TotalPurchases OBSupplementaryData1: type: object properties: {} additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. PostBox: description: 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. type: string example: PO Box 123456 minLength: 1 maxLength: 16 ExternalCategoryPurpose1Code: description: Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - BONU - CASH - CBLK - CCRD - CGWV - CIPC - CONC - CORT - DCRD - DIVI - DVPM - EPAY - FCDT - FCIN - FCOL - GOVT - GP2P - HEDG - ICCP - IDCP - INTC - INTE - LBOX - LOAN - MP2B - MP2P - OTHR - PENS - RPRE - RRCT - RVPM - SALA - SECU - SSBE - SUPP - SWEP - TAXS - TOPG - TRAD - TREA - VATX - VOST - WHLD - ZABA OBError1: type: object properties: ErrorCode: $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future'' OBL doesn''t standardise this field' type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode additionalProperties: false minProperties: 1 OBInternalStatementValueType1Code: description: Statement value type, in a coded form. For a full list of values see `OBInternalStatementValueType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.Credit x-namespaced-enum: - UK.OBIE.AirMilesPoints - UK.OBIE.AirMilesPointsBalance - UK.OBIE.Credits - UK.OBIE.Debits - UK.OBIE.HotelPoints - UK.OBIE.HotelPointsBalance - UK.OBIE.RetailShoppingPoints - UK.OBIE.RetailShoppingPointsBalance ISODateTime: description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time StatementId: description: Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable. type: string example: 8sfhke-sifhkeuf-97813 minLength: 1 maxLength: 40 EndDateTime: description: "Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string example: '2017-07-12T00:00:00+00:00' format: date-time OBCreditDebitCode_2: description: "Indicates whether the balance is a credit or a debit balance. \nUsage: A zero balance is considered to be a credit balance.\n
\nFor a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" type: string example: Credit enum: - Credit - Debit AddressLine: description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. type: string minLength: 1 maxLength: 70 OBInternalFinancialInstitutionIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.BICFI x-namespaced-enum: - UK.OBIE.BICFI BookingDateTime: description: "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Rate: description: Rate associated with the statement rate type. type: string example: '0.224' maxLength: 40 pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ OBActiveOrHistoricCurrencyAndAmount_10: type: object required: - Amount - Currency description: Transaction charges to be paid by the charge bearer. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' BuildingNumber: description: Number that identifies the position of a building on a street. type: string example: '11' minLength: 1 maxLength: 16 OBTransaction6: type: object description: Provides further details on an entry in the report. required: - AccountId - CreditDebitIndicator - Status - BookingDateTime - Amount properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/ExternalEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBInternalTransactionMutability1Code' BookingDateTime: $ref: '#/components/schemas/BookingDateTime' ValueDateTime: $ref: '#/components/schemas/ValueDateTime' TransactionInformation: $ref: '#/components/schemas/TransactionInformation' AddressLine: $ref: '#/components/schemas/AddressLine' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9' ChargeAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10' CurrencyExchange: $ref: '#/components/schemas/OBCurrencyExchange5' BankTransactionCode: $ref: '#/components/schemas/OBBankTransactionCodeStructure1' ProprietaryBankTransactionCode: $ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1' ExtendedProprietaryBankTransactionCodes: type: array items: $ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode' Balance: $ref: '#/components/schemas/OBTransactionCashBalance' MerchantDetails: $ref: '#/components/schemas/OBMerchantDetails1' CreditorAgent: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_1' CreditorAccount: $ref: '#/components/schemas/OBCashAccount6_0' DebtorAgent: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_2' DebtorAccount: $ref: '#/components/schemas/OBCashAccount6_1' CardInstrument: $ref: '#/components/schemas/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' PaymentPurposeCode: $ref: '#/components/schemas/OBExternalPurpose1Code' UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' IntermediaryAgent1: $ref: '#/components/schemas/OBIntermediaryAgent' IntermediaryAgent2: $ref: '#/components/schemas/OBIntermediaryAgent' IntermediaryAgent3: $ref: '#/components/schemas/OBIntermediaryAgent' additionalProperties: false OBUltimateCreditor1: description: Ultimate party to which an amount of money is due. type: object properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 Identification: description: Identification assigned by an institution. type: string minLength: 1 maxLength: 256 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' File: type: object properties: {} ExternalProxyAccountType1Code: description: 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 `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: TELE enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID OBReadDataStatement2: type: object properties: Statement: type: array items: $ref: '#/components/schemas/OBStatement2' additionalProperties: false StreetName: description: Name of a street or thoroughfare. type: string example: Bank Street minLength: 1 maxLength: 140 OBInternalStatementFeeRateType1Code: description: This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see `OBInternalStatementFeeRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.AER x-namespaced-enum: - UK.OBIE.AER - UK.OBIE.EAR Floor: description: Number that identifies the level within a building type: string example: '11' minLength: 1 maxLength: 70 ProprietaryBankTransactionCodeStructure1: type: object required: - Code description: Set of elements to fully identify a proprietary bank transaction code. properties: Code: description: Proprietary bank transaction code to identify the underlying transaction. type: string minLength: 1 maxLength: 35 Issuer: description: Identification of the issuer of the proprietary bank transaction code. type: string minLength: 1 maxLength: 35 additionalProperties: false OBTransactionCardInstrument1: type: object required: - CardSchemeName description: 'Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' properties: CardSchemeName: description: 'Name of the card scheme.
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string enum: - AmericanExpress - Diners - Discover - MasterCard - VISA AuthorisationType: description: 'The card authorisation type.
For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string enum: - ConsumerDevice - Contactless - None - PIN Name: description: Name of the cardholder using the card instrument. type: string minLength: 1 maxLength: 70 Identification: description: Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked. type: string minLength: 1 maxLength: 34 additionalProperties: false StatementReference: description: Unique reference for the statement. This reference may be optionally populated if available. type: string example: '002' minLength: 1 maxLength: 35 OBExternalStatusReason1Code: description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 4 maxLength: 4 example: U001 OBInternalStatementBenefitType1Code: description: Benefit type, in a coded form. For a full list of values see `OBInternalStatementBenefitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.Cashback x-namespaced-enum: - UK.OBIE.Cashback - UK.OBIE.Insurance - UK.OBIE.TravelDiscount - UK.OBIE.TravelInsurance TransactionReference: description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. type: string minLength: 1 maxLength: 210 OBStatement2: type: object description: Provides further details on a statement resource. required: - AccountId - Type - StartDateTime - EndDateTime - CreationDateTime properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBInternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/CreationDateTime' StatementDescription: type: array items: description: Other descriptions that may be available for the statement resource. type: string example: August 2017 Statement minLength: 1 maxLength: 500 StatementBenefit: type: array items: type: object description: Set of elements used to provide details of a benefit or reward amount for the statement resource. required: - Type - Amount properties: Type: $ref: '#/components/schemas/OBInternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' StatementFee: type: array items: type: object description: Set of elements used to provide details of a fee for the statement resource. required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBInternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' StatementInterest: type: array items: type: object description: Set of elements used to provide details of a generic interest amount related to the statement resource. required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBInternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' StatementAmount: type: array items: type: object description: Set of elements used to provide details of a generic amount for the statement resource. required: - CreditDebitIndicator - Type - Amount properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementAmountType1Code' Amount: type: object required: - Amount - Currency description: Amount of money of the cash balance. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: description: The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified type: string enum: - BCUR - LCUR default: BCUR LocalAmount: type: object required: - Amount - Currency description: Optional component providing the equivalent of Amount in local currency. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: description: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified type: string enum: - BCUR - LCUR default: LCUR StatementDateTime: type: array items: type: object description: Set of elements used to provide details of a generic date time for the statement resource. required: - DateTime - Type properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code' StatementRate: type: array items: type: object description: Set of elements used to provide details of a generic rate related to the statement resource. required: - Rate - Type properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBInternalStatementRateType1Code' StatementValue: type: array items: type: object description: Set of elements used to provide details of a generic number value related to the statement resource. required: - Value - Type properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBInternalStatementValueType1Code' TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false OBInternalStatementInterestFrequency1Code: description: Specifies the statement fee type requested. For a full list of values see `OBInternalStatementInterestFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.Monthly x-namespaced-enum: - UK.OBIE.Daily - UK.OBIE.HalfYearly - UK.OBIE.Monthly - UK.OBIE.PerStatementDate - UK.OBIE.Quarterly - UK.OBIE.Weekly - UK.OBIE.Yearly OBInternalStatementDateTimeType1Code: description: Date time type, in a coded form. For a full list of values see `OBInternalStatementDateTimeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.NextStatement x-namespaced-enum: - UK.OBIE.BalanceTransferPromoEnd - UK.OBIE.DirectDebitDue - UK.OBIE.LastPayment - UK.OBIE.LastStatement - UK.OBIE.NextStatement - UK.OBIE.PaymentDue - UK.OBIE.PurchasePromoEnd - UK.OBIE.StatementAvailable Description_1: description: Description that may be available for the statement fee. type: string example: International usage charge minLength: 1 maxLength: 128 LEI: description: 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 "Financial Services - Legal Entity Identifier (LEI)". type: string example: IZ9Q00LZEVUKWCQY6X15 minLength: 1 maxLength: 20 pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string example: London minLength: 1 maxLength: 140 SecondaryIdentification: description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)." type: string example: '87562298675897' minLength: 1 maxLength: 34 Value: description: Value associated with the statement value type. type: string minLength: 1 maxLength: 40 DistrictName: description: Number that of the regional area, known as a district, which forms part of an address type: string example: Greater London minLength: 1 maxLength: 140 ValueDateTime: description: "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 transaction entry.\nUsage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time OBBalanceType1Code: description: Balance type, in a coded form.
For a full list of enumeration values refer to `ExternalBalanceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string example: CLAV enum: - CLAV - CLBD - FWAV - INFO - ITAV - ITBD - OPAV - OPBD - PRCD - XPCD OBReadDataTransaction6: type: object properties: Transaction: type: array items: $ref: '#/components/schemas/OBTransaction6' additionalProperties: false Room: description: Information that locates and identifies a room to form part of an address type: string example: Basement 03 minLength: 1 maxLength: 70 OBActiveCurrencyAndAmount_SimpleType: description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string example: '1209.06' pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ Name_0: description: '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 name is not the product name or the nickname of the account.' type: string example: Jane Smith minLength: 1 maxLength: 350 OBReadStatement2: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBReadDataStatement2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' additionalProperties: false OBInternalStatementInterestType1Code: description: Interest amount type, in a coded form. For a full list of values see `OBInternalStatementInterestType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.Total x-namespaced-enum: - UK.OBIE.BalanceTransfer - UK.OBIE.Cash - UK.OBIE.EstimatedNext - UK.OBIE.Purchase - UK.OBIE.Total - UK.OBIE.InstalmentPlan - UK.OBIE.MoneyTransfer OBBranchAndFinancialInstitutionIdentification6_2: type: object description: Financial institution servicing an account for the debtor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBActiveOrHistoricCurrencyAndAmount_6: type: object required: - Amount - Currency description: Amount of money associated with the statement fee type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' ActiveOrHistoricCurrencyCode_1: description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". type: string example: GBP pattern: ^[A-Z]{3,3}$ CareOf: description: 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 for the individual. type: string example: Jane Smith minLength: 1 maxLength: 140 BuildingName: description: Name of a referenced building. type: string minLength: 1 maxLength: 140 OBCreditDebitCode_0: description: 'Indicates whether the amount is a credit or a debit. For a full list of values see `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
Usage: A zero amount is considered to be a credit amount.' type: string example: Credit enum: - Credit - Debit OBInternalStatementInterestRateType1Code: description: This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross). type: string example: UK.OBIE.FixedRate x-namespaced-enum: - UK.OBIE.BOEBaseRate - UK.OBIE.FixedRate - UK.OBIE.Gross - UK.OBIE.LoanProviderBaseRate - UK.OBIE.Net OBRate1_0: description: Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount) example: 0.05 type: number OBPostalAddress7: type: object description: Information that locates and identifies a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/OBAddressType2Code' Department: description: Identification of a division of a large organisation or building. example: Finance type: string minLength: 1 maxLength: 70 SubDepartment: description: Identification of a sub-division of a large organisation or building. example: Payroll type: string minLength: 1 maxLength: 70 StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' BuildingName: $ref: '#/components/schemas/BuildingName' Floor: $ref: '#/components/schemas/Floor' UnitNumber: $ref: '#/components/schemas/UnitNumber' Room: $ref: '#/components/schemas/Room' PostBox: $ref: '#/components/schemas/PostBox' TownLocationName: $ref: '#/components/schemas/TownName' DistrictName: $ref: '#/components/schemas/DistrictName' CareOf: $ref: '#/components/schemas/CareOf' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 Country: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ AddressLine: type: array items: description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. type: string minLength: 1 maxLength: 70 minItems: 0 maxItems: 7 OBTransactionCashBalance: type: object required: - CreditDebitIndicator - Type - Amount description: 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 to the account. properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_2' Type: $ref: '#/components/schemas/OBBalanceType1Code' Amount: type: object required: - Amount - Currency description: Amount of money of the cash balance after a transaction entry is applied to the account.. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' additionalProperties: false OBActiveOrHistoricCurrencyAndAmount_5: type: object required: - Amount - Currency description: Amount of money associated with the statement benefit type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBAddressType2Code: description: Identifies the nature of the postal address.
For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string example: BIZZ enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME - CORR - STAT OBCurrencyExchange5: type: object required: - SourceCurrency - ExchangeRate description: Set of elements used to provide details on the currency exchange. properties: SourceCurrency: description: Currency from which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ TargetCurrency: description: Currency into which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: 'Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).' type: number ContractIdentification: description: Unique identification to unambiguously identify the foreign exchange contract. type: string minLength: 1 maxLength: 35 QuotationDate: description: "Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time InstructedAmount: type: object required: - Amount - Currency description: 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. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBInternalStatementRateType1Code: description: Statement rate type, in a coded form. For a full list of values see `OBInternalStatementRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.AnnualCash x-namespaced-enum: - UK.OBIE.AnnualBalanceTransfer - UK.OBIE.AnnualBalanceTransferAfterPromo - UK.OBIE.AnnualBalanceTransferPromo - UK.OBIE.AnnualCash - UK.OBIE.AnnualPurchase - UK.OBIE.AnnualPurchaseAfterPromo - UK.OBIE.AnnualPurchasePromo - UK.OBIE.MonthlyBalanceTransfer - UK.OBIE.MonthlyCash - UK.OBIE.MonthlyPurchase OBExternalPurpose1Code: type: string minLength: 1 maxLength: 4 description: For a full list of enumeration values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BKDF - BKFE - BKFM - BKIP - BKPP - CBLK - CDCB - CDCD - CDCS - CDDP - CDOC - CDQC - ETUP - FCOL - MTUP - ACCT - CASH - COLL - CSDB - DEPT - INTC - INTP - LIMA - NETT - BFWD - CCIR - CCPC - CCPM - CCSM - CRDS - CRPR - CRSP - CRTL - EQPT - EQUS - EXPT - EXTD - FIXI - FWBC - FWCC - FWSB - FWSC - MARG - MBSB - MBSC - MGCC - MGSC - OCCC - OPBC - OPCC - OPSB - OPSC - OPTN - OTCD - REPO - RPBC - RPCC - RPSB - RPSC - RVPO - SBSC - SCIE - SCIR - SCRP - SHBC - SHCC - SHSL - SLEB - SLOA - SWBC - SWCC - SWPT - SWSB - SWSC - TBAS - TBBC - TBCC - TRCP - AGRT - AREN - BEXP - BOCE - COMC - CPYR - GDDS - GDSV - GSCB - LICF - MP2B - POPE - ROYA - SCVE - SERV - SUBS - SUPP - TRAD - CHAR - COMT - MP2P - ECPG - ECPR - ECPU - EPAY - CLPR - COMP - DBTC - GOVI - HLRP - HLST - INPC - INPR - INSC - INSU - INTE - LBRI - LIFI - LOAN - LOAR - PENO - PPTI - RELG - RINP - TRFD - FORW - FXNT - ADMG - ADVA - BCDM - BCFG - BLDM - BNET - CBFF - CBFR - CCRD - CDBL - CFEE - CGDD - CORT - COST - CPKC - DCRD - DSMT - DVPM - EDUC - FACT - FAND - FCPM - FEES - GIFT - GOVT - ICCP - IDCP - IHRP - INSM - IVPT - MCDM - MCFG - MSVC - NOWS - OCDM - OCFG - OFEE - OTHR - PADD - PTSP - RCKE - RCPT - REBT - REFU - RENT - REOD - RIMB - RPNT - RRBN - RRCT - RRTP - RVPM - SLPI - SPLT - STDY - TBAN - TBIL - TCSC - TELI - TMPG - TPRI - TPRP - TRNC - TRVC - WEBI - IPAY - IPCA - IPDO - IPEA - IPEC - IPEW - IPPS - IPRT - IPU2 - IPUW - ANNI - CAFI - CFDI - CMDT - DERI - DIVD - FREX - HEDG - INVS - PRME - SAVG - SECU - SEPI - TREA - UNIT - FNET - FUTR - ANTS - CVCF - DMEQ - DNTS - HLTC - HLTI - HSPC - ICRF - LTCF - MAFC - MARF - MDCS - VIEW - CDEP - SWFP - SWPP - SWRS - SWUF - ADCS - AEMP - ALLW - ALMY - BBSC - BECH - BENE - BONU - CCHD - COMM - CSLP - GFRP - GVEA - GVEB - GVEC - GVED - GWLT - HREC - PAYR - PEFC - PENS - PRCP - RHBS - SALA - SPSP - SSBE - LBIN - LCOL - LFEE - LMEQ - LMFI - LMRK - LREB - LREV - LSFL - ESTX - FWLV - GSTX - HSTX - INTX - NITX - PTXP - RDTX - TAXS - VATX - WHLD - TAXR - B112 - BR12 - TLRF - TLRR - AIRB - BUSB - FERB - RLWY - TRPT - CBTV - ELEC - ENRG - GASB - NWCH - NWCM - OTLC - PHON - UBIL - WTER - BOND - CABD - CAEQ - CBCR - DBCR - DICL - EQTS - FLCR - EFTC - EFTD - MOMA - RAPI - GAMB - LOTT - AMEX - SASW - AUCO - PCOM - PDEP - PLDS - PLRF - GAFA - GAHO - CPEN - DEPD - RETL - DEBT - CRYP OBCreditDebitCode_1: description: 'Indicates whether the transaction is a credit or a debit entry.

For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string enum: - Credit - Debit Identification_2: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name_1: description: Name by which an agent is known and which is usually used to identify that agent. type: string example: Agent Name minLength: 1 maxLength: 140 ExternalEntryStatus1Code: description: 'Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer to `ExternalEntryStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string enum: - BOOK - FUTR - INFO - PDNG - RJCT OBCashAccount6_1: type: object description: Unambiguous identification of the account of the debtor, in the case of a credit transaction. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' StartDateTime: description: "Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string example: '2017-07-12T00:00:00+00:00' format: date-time TransactionId: description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable. type: string minLength: 1 maxLength: 210 OBBankTransactionCodeStructure1: type: object required: - Code - SubCode description: Set of elements used to fully identify the type of underlying transaction resulting in an entry. properties: Code: description: Specifies the family within a domain. type: string SubCode: description: Specifies the sub-product family within a specific family. type: string DateTime: description: "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string example: '2024-05-29T00:00:00Z' format: date-time AccountId: description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. type: string example: '22289' minLength: 1 maxLength: 40 TransactionInformation: description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text." type: string minLength: 1 maxLength: 500 OBBranchAndFinancialInstitutionIdentification6_1: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBMerchantDetails1: type: object description: Details of the merchant involved in the transaction. properties: MerchantName: description: Name by which the merchant is known. type: string minLength: 1 maxLength: 350 MerchantCategoryCode: description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. type: string minLength: 3 maxLength: 4 OBInternalTransactionMutability1Code: description: 'Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer to `OBInternalTransactionMutability1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string enum: - Mutable - Immutable OBInternalStatementType1Code: description: Statement type, in a coded form. For a full list of values see `OBInternalStatementType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: RegularPeriodic enum: - AccountClosure - AccountOpening - Annual - Interim - RegularPeriodic Identification_0: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string example: '80200112344562' minLength: 1 maxLength: 256 OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Code: description: Deprecated
High level textual error code, to help categorise the errors. type: string minLength: 1 example: 400 BadRequest maxLength: 40 Message: description: Deprecated
Brief Error message type: string minLength: 1 example: There is something wrong with the request parameters provided maxLength: 500 Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Errors additionalProperties: false PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string example: EC2N 4AG minLength: 1 maxLength: 16 Links: type: object description: Links relevant to the payload properties: Self: type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri additionalProperties: false required: - Self OBIntermediaryAgent: description: The intermediary agent associated with this transaction. type: object properties: Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProcessingStatus: description: Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - PDNG - RCVD - ACSP - ACSC - RJCT - UNKN - CANC Meta: title: MetaData type: object description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' additionalProperties: false OBUltimateDebtor1: description: Ultimate party that owes an amount of money to the (ultimate) creditor. type: object properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 Identification: description: Identification assigned by an institution. type: string minLength: 1 maxLength: 256 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBInternalStatementFeeFrequency1Code: description: How frequently the fee is applied to the Account. For a full list of values see `OBInternalStatementFeeFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string example: UK.OBIE.StatementMonthly x-namespaced-enum: - UK.OBIE.ChargingPeriod - UK.OBIE.PerTransactionAmount - UK.OBIE.PerTransactionPercentage - UK.OBIE.Quarterly - UK.OBIE.StatementMonthly - UK.OBIE.Weekly OBRate1_1: description: Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount) example: 0.05 type: number CreationDateTime: description: "Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string example: '2024-05-29T00:00:00Z' format: date-time OBActiveOrHistoricCurrencyAndAmount_7: type: object required: - Amount - Currency description: Amount of money associated with the statement interest amount type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBReadTransaction6: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBReadDataTransaction6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' additionalProperties: false Description_2: description: Description that may be available for the statement interest. example: Interest occurred over statement duration type: string minLength: 1 maxLength: 128 OBActiveOrHistoricCurrencyAndAmount_9: type: object required: - Amount - Currency description: Amount of money in the cash transaction entry. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' parameters: x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the PSU is using. required: false schema: type: string AccountId: name: AccountId in: path description: AccountId required: true schema: type: string ToStatementDateTimeParam: in: query name: toStatementDateTime description: 'The UTC ISO 8601 Date Time to filter statements TO. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string format: date-time example: '2026-12-31T23:59:59' x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" schema: type: string pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ x-client-id: in: header name: x-client-id required: false description: "Only used if an ASPSP requires the client ID in order to return rate limit headers. \n\nTPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.\n\nThis header __must not__ be used for client authentication\n" schema: type: string x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string FromStatementDateTimeParam: in: query name: fromStatementDateTime description: 'The UTC ISO 8601 Date Time to filter statements FROM. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string format: date-time example: '2026-01-01T00:00:00' Authorization: in: header name: Authorization required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 schema: type: string StatementId: name: StatementId in: path description: StatementId required: true schema: type: string responses: 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 200StatementsRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' 200AccountsAccountIdStatementsStatementIdFileRead: description: 'Statements Read ASPSP will specify all available content types ' headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/File' application/json: schema: $ref: '#/components/schemas/File' application/jose+jwe: schema: $ref: '#/components/schemas/File' 200AccountsAccountIdStatementsStatementIdTransactionsRead: description: Transactions Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadTransaction6' application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadTransaction6' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 200AccountsAccountIdStatementsStatementIdRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' 200AccountsAccountIdStatementsRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' headers: RateLimit: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A server uses the "RateLimit" response header field to communicate the current service limit for a quota policy for a particular partition key. Example: `RateLimit: "default";r=50;t=30` The **REQUIRED** "r" parameter value conveys the remaining quota units for the identified policy. The **OPTIONAL** "t" parameter value conveys the time window reset time for the identified policy. ' schema: type: string RateLimit-Policy: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A non-empty list of Quota Policy Items. The Item value __MUST__ be a String. Example: `RateLimit-Policy: "default";q=100;w=10` The **REQUIRED** "q" parameter indicates the quota allocated by this policy measured in quota units. The **OPTIONAL** "w" parameter value conveys a time window. ' schema: type: string securitySchemes: TPPOAuth2Security: type: oauth2 description: TPP client credential authorisation flow with the ASPSP flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information PSUOAuth2Security: type: oauth2 description: 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 flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information