openapi: 3.2.0 info: title: Account and Transactions Statements API description: To retrieve account information for Barclays customers termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk url: https://www.openbanking.org.uk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: v4.0 tags: - name: Statements description: Get Statements paths: /accounts/{accountId}/statements: summary: Get Statements description: Get 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' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/statements/{statementId}/transactions: summary: Get Transactions description: Get 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' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/statements/{statementId}/file: summary: Get Statements description: Get Statements 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' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /statements: summary: Get Statements description: Get 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' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/statements/{statementId}: summary: Get Statements description: Get Statements 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' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false components: schemas: Meta: type: object additionalProperties: false description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 example: 42 maximum: 999999 minimum: 0 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' title: MetaData CreationDateTime: type: string format: date-time 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" example: '2024-05-29T00:00:00Z' TransactionReference: type: string description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. maxLength: 210 minLength: 1 ActiveOrHistoricCurrencyCode_1: type: string 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". example: GBP pattern: ^[A-Z]{3,3}$ Description_1: type: string description: Description that may be available for the statement fee. example: International usage charge maxLength: 128 minLength: 1 OBReadDataTransaction6: type: object additionalProperties: false deprecated: false properties: Transaction: type: array items: $ref: '#/components/schemas/OBTransaction6' maxItems: 99999 minItems: 0 nullable: false Rate: type: string description: Rate associated with the statement rate type. example: '0.224' maxLength: 40 pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ SecondaryIdentification: type: string 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)." example: '87562298675897' maxLength: 34 minLength: 1 Identification_2: type: string description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. maxLength: 35 minLength: 1 OBReadTransaction6: type: object additionalProperties: false deprecated: false properties: Data: $ref: '#/components/schemas/OBReadDataTransaction6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBRate1_1: type: number description: Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount) example: 0.05 BookingDateTime: type: string format: date-time 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" ExternalCategoryPurpose1Code: type: string 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) 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 OBExternalPurpose1Code: type: string 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 maxLength: 4 minLength: 1 OBProxy1: type: object description: Specifies an alternate assumed name for the identification of the account. properties: Identification: type: string description: Identification used to indicate the account identification under another specified name. example: '2360549017905188' maxLength: 2048 minLength: 1 Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. maxLength: 35 minLength: 1 required: - Code - Identification OBStatement2: type: object additionalProperties: false deprecated: false description: Provides further details on a statement resource. 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: type: string description: Other descriptions that may be available for the statement resource. example: August 2017 Statement maxLength: 500 minLength: 1 maxItems: 99999 minItems: 0 StatementBenefit: type: array items: type: object description: Set of elements used to provide details of a benefit or reward amount for the statement resource. properties: Type: $ref: '#/components/schemas/OBInternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' required: - Amount - Type maxItems: 99999 minItems: 0 StatementFee: type: array items: type: object description: Set of elements used to provide details of a fee for the statement resource. 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' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementInterest: type: array items: type: object description: Set of elements used to provide details of a generic interest amount related to the statement resource. 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' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementAmount: type: array items: type: object description: Set of elements used to provide details of a generic amount for the statement resource. properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementAmountType1Code' Amount: type: object description: Amount of money of the cash balance. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: BCUR description: The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified enum: - BCUR - LCUR required: - Amount - Currency LocalAmount: type: object 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: type: string default: LCUR description: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified enum: - BCUR - LCUR required: - Amount - Currency required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementDateTime: type: array items: type: object description: Set of elements used to provide details of a generic date time for the statement resource. properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code' required: - DateTime - Type maxItems: 99999 minItems: 0 StatementRate: type: array items: type: object description: Set of elements used to provide details of a generic rate related to the statement resource. properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBInternalStatementRateType1Code' required: - Rate - Type maxItems: 99999 minItems: 0 StatementValue: type: array items: type: object description: Set of elements used to provide details of a generic number value related to the statement resource. properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBInternalStatementValueType1Code' required: - Type - Value maxItems: 99999 minItems: 0 TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - AccountId - CreationDateTime - EndDateTime - StartDateTime - Type nullable: false OBInternalStatementValueType1Code: type: string 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) 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 StartDateTime: type: string format: date-time 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" example: '2017-07-12T00:00:00Z' OBBankTransactionCodeStructure1: type: object description: Set of elements used to fully identify the type of underlying transaction resulting in an entry. properties: Code: type: string description: Specifies the family within a domain. SubCode: type: string description: Specifies the sub-product family within a specific family. required: - Code - SubCode OBSupplementaryData1: type: object additionalProperties: true deprecated: false description: Additional information that can not be captured in the structured fields and/or any other specific block. nullable: false PostCode: type: string description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. example: EC2N 4AG maxLength: 16 minLength: 1 OBReadStatement2: type: object additionalProperties: false deprecated: false properties: Data: $ref: '#/components/schemas/OBReadDataStatement2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBInternalStatementFeeType1Code: type: string 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) 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 ProprietaryBankTransactionCodeStructure1: type: object additionalProperties: false description: Set of elements to fully identify a proprietary bank transaction code. properties: Code: type: string description: Proprietary bank transaction code to identify the underlying transaction. maxLength: 35 minLength: 1 Issuer: type: string description: Identification of the issuer of the proprietary bank transaction code. maxLength: 35 minLength: 1 required: - Code UnitNumber: type: string description: Number that identifies the unit of a specific address . example: A88 maxLength: 16 minLength: 1 OBUltimateCreditor1: type: object description: Ultimate party to which an amount of money is due. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. maxLength: 140 minLength: 1 Identification: type: string description: Identification assigned by an institution. maxLength: 256 minLength: 1 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBInternalStatementRateType1Code: type: string 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) 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 OBInternalTransactionMutability1Code: type: string 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)' enum: - Mutable - Immutable AccountId: type: string description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. example: '22289' maxLength: 40 minLength: 1 BuildingName: type: string description: Name of a referenced building. maxLength: 140 minLength: 1 OBAddressType2Code: type: string 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). enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME - CORR - STAT example: BIZZ EndDateTime: type: string format: date-time 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" example: '2017-07-12T00:00:00Z' TransactionInformation: type: string description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text." maxLength: 500 minLength: 1 OBInternalStatementInterestFrequency1Code: type: string 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) 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 OBExternalStatusReason1Code: type: string description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: U001 maxLength: 4 minLength: 4 TownName: type: string description: Name of a built-up area, with defined boundaries, and a local government. example: London maxLength: 140 minLength: 1 TransactionId: type: string description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable. maxLength: 210 minLength: 1 OBActiveCurrencyAndAmount_SimpleType: type: string description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. example: '1209.06' pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ 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' 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' CareOf: type: string 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. example: Jane Smith maxLength: 140 minLength: 1 OBInternalFinancialInstitutionIdentification4Code: type: string 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) example: UK.OBIE.BICFI x-namespaced-enum: - UK.OBIE.BICFI PostBox: type: string 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. example: PO Box 123456 maxLength: 16 minLength: 1 Name_0: type: string 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.' example: Jane Smith maxLength: 350 minLength: 1 ExternalProxyAccountType1Code: type: string 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) enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID example: TELE ValueDateTime: type: string format: date-time 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" OBBalanceType1Code: type: string 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). enum: - CLAV - CLBD - FWAV - INFO - ITAV - ITBD - OPAV - OPBD - PRCD - XPCD example: CLAV OBErrorResponse1: type: object additionalProperties: false deprecated: false description: An array of detail error codes, and messages, and URLs to documentation to help remediation. properties: Id: type: string description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. maxLength: 40 minLength: 1 Code: type: string description: Deprecated
High level textual error code, to help categorise the errors. example: 400 BadRequest maxLength: 40 minLength: 1 Message: type: string description: Deprecated
Brief Error message example: There is something wrong with the request parameters provided maxLength: 500 minLength: 1 Errors: type: array items: $ref: '#/components/schemas/OBError1' maxItems: 99999 minItems: 1 required: - Errors nullable: false OBPostalAddress7: type: object description: Information that locates and identifies a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/OBAddressType2Code' Department: type: string description: Identification of a division of a large organisation or building. example: Finance maxLength: 70 minLength: 1 SubDepartment: type: string description: Identification of a sub-division of a large organisation or building. example: Payroll maxLength: 70 minLength: 1 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: type: string description: Identifies a subdivision of a country such as state, region, county. maxLength: 35 minLength: 1 Country: type: string description: Nation with its own government. pattern: ^[A-Z]{2,2}$ AddressLine: type: array items: type: string description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. maxLength: 70 minLength: 1 maxItems: 7 minItems: 0 AddressLine: type: string description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. maxLength: 70 minLength: 1 OBTransaction6: type: object additionalProperties: false deprecated: false description: Provides further details on an entry in the report. properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' maxItems: 99999 minItems: 0 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' maxItems: 99999 minItems: 0 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' required: - AccountId - Amount - BookingDateTime - CreditDebitIndicator - Status nullable: false Room: type: string description: Information that locates and identifies a room to form part of an address example: Basement 03 maxLength: 70 minLength: 1 OBInternalStatementType1Code: type: string 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) enum: - AccountClosure - AccountOpening - Annual - Interim - RegularPeriodic example: RegularPeriodic OBInternalStatementFeeRateType1Code: type: string 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) example: UK.OBIE.AER x-namespaced-enum: - UK.OBIE.AER - UK.OBIE.EAR LEI: type: string 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)". example: IZ9Q00LZEVUKWCQY6X15 maxLength: 20 minLength: 1 pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ OBCurrencyExchange5: type: object description: Set of elements used to provide details on the currency exchange. properties: SourceCurrency: type: string description: Currency from which an amount is to be converted in a currency conversion. pattern: ^[A-Z]{3,3}$ TargetCurrency: type: string description: Currency into which an amount is to be converted in a currency conversion. pattern: ^[A-Z]{3,3}$ UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number 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).' ContractIdentification: type: string description: Unique identification to unambiguously identify the foreign exchange contract. maxLength: 35 minLength: 1 QuotationDate: type: string format: date-time 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" InstructedAmount: type: object 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' required: - Amount - Currency required: - ExchangeRate - SourceCurrency OBInternalStatementInterestType1Code: type: string 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) example: UK.OBIE.Total x-namespaced-enum: - UK.OBIE.BalanceTransfer - UK.OBIE.Cash - UK.OBIE.EstimatedNext - UK.OBIE.Purchase - UK.OBIE.Total OBInternalStatementInterestRateType1Code: type: string description: This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross). example: UK.OBIE.FixedRate x-namespaced-enum: - UK.OBIE.BOEBaseRate - UK.OBIE.FixedRate - UK.OBIE.Gross - UK.OBIE.LoanProviderBaseRate - UK.OBIE.Net OBCreditDebitCode_2: type: string 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)" enum: - Credit - Debit example: Credit OBActiveOrHistoricCurrencyAndAmount_5: type: object description: Amount of money associated with the statement benefit type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBIntermediaryAgent: type: object description: The intermediary agent associated with this transaction. properties: Name: type: string description: Name by which an agent is known and which is usually used to identify that agent. example: name maxLength: 140 minLength: 1 SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: type: string description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. example: id maxLength: 35 minLength: 1 LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProcessingStatus: type: string 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) enum: - PDNG - RCVD - ACSP - ACSC - RJCT - UNKN - CANC example: ACSP OBTransactionCardInstrument1: type: object additionalProperties: false deprecated: false 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: type: string 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)' enum: - AmericanExpress - Diners - Discover - MasterCard - VISA AuthorisationType: type: string 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)' enum: - ConsumerDevice - Contactless - None - PIN Name: type: string description: Name of the cardholder using the card instrument. maxLength: 70 minLength: 1 Identification: type: string 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. maxLength: 34 minLength: 1 required: - CardSchemeName nullable: false OBActiveOrHistoricCurrencyAndAmount_9: type: object description: Amount of money in the cash transaction entry. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBInternalStatementDateTimeType1Code: type: string 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) 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 OBRate1_0: type: number description: Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount) example: 0.05 OBExtendedProprietaryBankTransactionCode: type: object description: Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction properties: Code: type: string description: Proprietary bank transaction code to identify the underlying transaction. maxLength: 35 minLength: 1 Issuer: type: string description: Identification of the issuer of the proprietary bank transaction code. maxLength: 35 minLength: 1 Description: type: string description: Description of the code and its usage on the ASPSP channel maxLength: 500 minLength: 1 required: - Code DateTime: type: string format: date-time 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" example: '2024-05-29T00:00:00Z' ISODateTime: type: string format: date-time 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" Description_2: type: string description: Description that may be available for the statement interest. example: Interest occurred over statement duration maxLength: 128 minLength: 1 OBCreditDebitCode_1: type: string 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)' enum: - Credit - Debit Identification_0: type: string description: Identification assigned by an institution to identify an account. This identification is known by the account owner. example: '80200112344562' maxLength: 256 minLength: 1 Links: type: object additionalProperties: false 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 required: - Self StatementId: type: string description: Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable. example: 8sfhke-sifhkeuf-97813 maxLength: 40 minLength: 1 StatementReference: type: string description: Unique reference for the statement. This reference may be optionally populated if available. example: '002' maxLength: 35 minLength: 1 OBReadDataStatement2: type: object additionalProperties: false deprecated: false properties: Statement: type: array items: $ref: '#/components/schemas/OBStatement2' maxItems: 99999 minItems: 0 nullable: false BuildingNumber: type: string description: Number that identifies the position of a building on a street. example: '11' maxLength: 16 minLength: 1 StreetName: type: string description: Name of a street or thoroughfare. example: Bank Street maxLength: 140 minLength: 1 ExternalEntryStatus1Code: type: string 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)' enum: - BOOK - FUTR - INFO - PDNG - RJCT OBInternalStatementAmountType1Code: type: string description: Amount type, in a coded form. 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 Value: type: string description: Value associated with the statement value type. maxLength: 40 minLength: 1 OBCreditDebitCode_0: type: string 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.' enum: - Credit - Debit example: Credit OBActiveOrHistoricCurrencyAndAmount_10: type: object description: Transaction charges to be paid by the charge bearer. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency 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' OBInternalStatementBenefitType1Code: type: string 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) example: UK.OBIE.Cashback x-namespaced-enum: - UK.OBIE.Cashback - UK.OBIE.Insurance - UK.OBIE.TravelDiscount - UK.OBIE.TravelInsurance Floor: type: string description: Number that identifies the level within a building example: '11' maxLength: 70 minLength: 1 OBInternalAccountIdentification4Code: type: string 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) x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet OBUltimateDebtor1: type: object description: Ultimate party that owes an amount of money to the (ultimate) creditor. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. maxLength: 140 minLength: 1 Identification: type: string description: Identification assigned by an institution. maxLength: 256 minLength: 1 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBError1: type: object additionalProperties: false minProperties: 1 properties: ErrorCode: $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: type: string 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' maxLength: 500 minLength: 1 Path: type: string description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency maxLength: 500 minLength: 1 Url: type: string description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc required: - ErrorCode OBActiveOrHistoricCurrencyAndAmount_7: type: object description: Amount of money associated with the statement interest amount type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency 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' OBTransactionCashBalance: type: object additionalProperties: false deprecated: false 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 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' required: - Amount - Currency required: - Amount - CreditDebitIndicator - Type nullable: false OBInternalStatementFeeFrequency1Code: type: string 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) 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 OBActiveOrHistoricCurrencyAndAmount_6: type: object description: Amount of money associated with the statement fee type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency DistrictName: type: string description: Number that of the regional area, known as a district, which forms part of an address example: Greater London maxLength: 140 minLength: 1 Name_1: type: string description: Name by which an agent is known and which is usually used to identify that agent. example: Agent Name maxLength: 140 minLength: 1 OBMerchantDetails1: type: object description: Details of the merchant involved in the transaction. properties: MerchantName: type: string description: Name by which the merchant is known. maxLength: 350 minLength: 1 MerchantCategoryCode: type: string description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. maxLength: 4 minLength: 3 responses: 200AccountsAccountIdStatementsRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' examples: get-account-statement-request: value: Data: Statement: - AccountId: '22289' StatementId: 8sfhke-sifhkeuf-97813 StatementReference: '002' Type: RegularPeriodic StartDateTime: '2017-08-01T00:00:00+00:00' EndDateTime: '2017-08-31T23:59:59+00:00' CreationDateTime: '2017-09-01T00:00:00+00:00' StatementDateTime: - DateTime: '2017-08-01T00:00:00+00:00' Type: UK.OBIE.DirectDebitDue TotalValue: Amount: '1024.00' Currency: GBP StatementDescription: - August 2017 Statement - One Free Uber Ride StatementAmount: - Amount: Amount: '400.00' Currency: GBP SubType: BCUR LocalAmount: Amount: '400.00' Currency: GBP SubType: BCUR CreditDebitIndicator: Credit Type: ClosingBalance - Amount: Amount: '600.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance StatementBenefit: - Type: UK.OBIE.Cashback Amount: Amount: '5.00' Currency: GBP StatementValue: - Type: UK.OBIE.AirMilesPoints Value: '100' StatementFee: - Description: International usage charge Type: UK.OBIE.ForeignTransaction Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.AER Frequency: UK.OBIE.StatementMonthly Amount: Amount: '03.75' Currency: GBP StatementInterest: - Description: Interest occurred over statement duration Type: UK.OBIE.Total Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.FixedRate Frequency: UK.OBIE.StatementMonthly Amount: Amount: '20.25' Currency: GBP StatementRate: - Rate: '0.229' Type: UK.OBIE.MonthlyPurchase - AccountId: '22289' StatementId: 34hj24u-324h33-31i3p4 StatementReference: '003' Type: RegularPeriodic StartDateTime: '2017-09-01T00:00:00+00:00' EndDateTime: '2017-09-30T23:59:59+00:00' CreationDateTime: '2017-10-01T00:00:00+00:00' StatementDescription: - September 2017 Statement StatementAmount: - Amount: Amount: '200.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance - Amount: Amount: '400.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/statements/ Meta: TotalPages: 1 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 400ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 200AccountsAccountIdStatementsStatementIdTransactionsRead: description: Transactions Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 403ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 500ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer deprecated: false maximum: 9999999 minimum: 1 nullable: false example: 120 x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 200AccountsAccountIdStatementsStatementIdRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' examples: get-account-statement-request: value: Data: Statement: - AccountId: '22289' StatementId: 8sfhke-sifhkeuf-97813 StatementReference: '002' Type: RegularPeriodic StartDateTime: '2017-08-01T00:00:00+00:00' EndDateTime: '2017-08-31T23:59:59+00:00' CreationDateTime: '2017-09-01T00:00:00+00:00' StatementDateTime: - DateTime: '2017-08-01T00:00:00+00:00' Type: UK.OBIE.DirectDebitDue TotalValue: Amount: '1024.00' Currency: GBP StatementDescription: - August 2017 Statement - One Free Uber Ride StatementAmount: - Amount: Amount: '400.00' Currency: GBP SubType: BCUR LocalAmount: Amount: '400.00' Currency: GBP SubType: BCUR CreditDebitIndicator: Credit Type: ClosingBalance - Amount: Amount: '600.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance StatementBenefit: - Type: UK.OBIE.Cashback Amount: Amount: '5.00' Currency: GBP StatementValue: - Type: UK.OBIE.AirMilesPoints Value: '100' StatementFee: - Description: International usage charge Type: UK.OBIE.ForeignTransaction Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.AER Frequency: UK.OBIE.StatementMonthly Amount: Amount: '03.75' Currency: GBP StatementInterest: - Description: Interest occurred over statement duration Type: UK.OBIE.Total Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.FixedRate Frequency: UK.OBIE.StatementMonthly Amount: Amount: '20.25' Currency: GBP StatementRate: - Rate: '0.229' Type: UK.OBIE.MonthlyPurchase - AccountId: '22289' StatementId: 34hj24u-324h33-31i3p4 StatementReference: '003' Type: RegularPeriodic StartDateTime: '2017-09-01T00:00:00+00:00' EndDateTime: '2017-09-30T23:59:59+00:00' CreationDateTime: '2017-10-01T00:00:00+00:00' StatementDescription: - September 2017 Statement StatementAmount: - Amount: Amount: '200.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance - Amount: Amount: '400.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/statements/ Meta: TotalPages: 1 parameters: ToStatementDateTimeParam: name: toStatementDateTime in: query 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 deprecated: false nullable: false example: '2026-12-31T23:59:59' FromStatementDateTimeParam: name: fromStatementDateTime in: query 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 deprecated: false nullable: false example: '2026-01-01T00:00:00' x-fapi-interaction-id: name: x-fapi-interaction-id in: header description: An RFC4122 UID used as a correlation id. required: false schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-fapi-customer-ip-address: name: x-fapi-customer-ip-address in: header description: The PSU's IP address if the PSU is currently logged in with the TPP. required: false schema: type: string maxLength: 40 minLength: 7 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ nullable: false example: 104.25.212.99 x-fapi-auth-date: name: x-fapi-auth-date in: header 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" required: false schema: type: string deprecated: false maxLength: 29 minLength: 29 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)$ nullable: false example: Sun, 10 Sep 2017 19:43:31 UTC AccountId: name: accountId in: path description: AccountId required: true schema: type: string deprecated: false maxLength: 20 minLength: 1 pattern: ^\d{1,20}$ nullable: false example: '12345678901234567890' x-customer-user-agent: name: x-customer-user-agent in: header description: Indicates the user-agent that the PSU is using. required: false schema: type: string deprecated: false maxLength: 500 minLength: 1 nullable: false example: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405 StatementId: name: statementId in: path description: StatementId required: true schema: type: string deprecated: false maxLength: 40 minLength: 1 nullable: false example: '1234567890' Authorization: name: Authorization in: header description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 required: true schema: type: string maxLength: 4871 minLength: 1 pattern: ^Bearer [A-Za-z0-9-_=]{1,256}\.\.[A-Za-z0-9-_=]{1,100}\.[A-Za-z0-9-_=]{1,4096}\.[A-Za-z0-9-_=]{1,100}$ nullable: false example: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0OTk4NTA5NjUsInN1YiI6IkJhcmNsYXlzX1BheW1lbnRfU2VydmljZSIsInNjb3BlIjpbImlkcy5tYW5hZ2Vfa2V5IiwiaWRzLm1hbmFnZV9jbGllbnQiXSwiaXNzIjoiaHR0cDovL2lkZW50aXR5LXNlcnZpY2UvIiwiaWF0IjoxNDk5ODUwMDY1fQ.OX-u14YLs7iksl6gnZ9ZqMBu-ekFi4pSva5mzhuf2xU 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