---
title: "Get Transactions"
method: GET
path: "/transactions"
tags: ["Transactions"]
---

# Get Transactions

`GET /transactions`

Enables an AISP to retrieve transaction information for account(s) that the PSU has consented to.

## Query parameters

- `fromBookingDateTime` string, date-time
- `toBookingDateTime` string, date-time

## Headers

- `x-fapi-auth-date` string
- `x-fapi-customer-ip-address` string
- `x-fapi-interaction-id` string
- `Authorization` string, required
- `x-customer-user-agent` string
- `x-client-id` string

## Response `200`

Transactions Read

- OBReadTransaction6
  - `Data` OBReadDataTransaction6, required
    - `Transaction` OBTransaction6[]
      - `AccountId` string, required — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
      - `TransactionId` string — Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
      - `TransactionReference` string — Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
      - `StatementReference` StatementReference[]
      - `CreditDebitIndicator` 'Credit' | 'Debit', required — Indicates whether the transaction is a credit or a debit entry. <br /> <br /> For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `Status` 'BOOK' | 'FUTR' | 'INFO' | 'PDNG' | 'RJCT', required — Status of a transaction entry on the books of the account servicer. <br /> For a full list of enumeration values refer to `ExternalEntryStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `TransactionMutability` 'Mutable' | 'Immutable' — Specifies the Mutability of the Transaction record. <br /> For a full list of enumeration values refer to `OBInternalTransactionMutability1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `BookingDateTime` string, date-time, required — Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
      - `ValueDateTime` string, date-time — 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. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
      - `TransactionInformation` string — Further details of the transaction. This is the transaction narrative, which is unstructured text.
      - `AddressLine` string — Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
      - `Amount` OBActiveOrHistoricCurrencyAndAmount9, required — Amount of money in the cash transaction entry.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — 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".
      - `ChargeAmount` OBActiveOrHistoricCurrencyAndAmount10 — Transaction charges to be paid by the charge bearer.
        - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
        - `Currency` string, required — 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".
      - `CurrencyExchange` OBCurrencyExchange5 — Set of elements used to provide details on the currency exchange.
        - `SourceCurrency` string, required — Currency from which an amount is to be converted in a currency conversion.
        - `TargetCurrency` string — Currency into which an amount is to be converted in a currency conversion.
        - `UnitCurrency` string — Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
        - `ExchangeRate` number, required — 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` string — Unique identification to unambiguously identify the foreign exchange contract.
        - `QuotationDate` string, date-time — Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
        - `InstructedAmount` object — Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
          - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
          - `Currency` string, required — 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".
      - `BankTransactionCode` OBBankTransactionCodeStructure1 — Set of elements used to fully identify the type of underlying transaction resulting in an entry.
        - `Code` string, required — Specifies the family within a domain.
        - `SubCode` string, required — Specifies the sub-product family within a specific family.
      - `ProprietaryBankTransactionCode` ProprietaryBankTransactionCodeStructure1 — Set of elements to fully identify a proprietary bank transaction code.
        - `Code` string, required — Proprietary bank transaction code to identify the underlying transaction.
        - `Issuer` string — Identification of the issuer of the proprietary bank transaction code.
      - `ExtendedProprietaryBankTransactionCodes` OBExtendedProprietaryBankTransactionCode[]
        - `Code` string, required — Proprietary bank transaction code to identify the underlying transaction.
        - `Issuer` string — Identification of the issuer of the proprietary bank transaction code.
        - `Description` string — Description of the code and its usage on the ASPSP channel
      - `Balance` OBTransactionCashBalance — 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.
        - `CreditDebitIndicator` 'Credit' | 'Debit', required — Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. <br /> For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Type` 'CLAV' | 'CLBD' | 'FWAV' | 'INFO' | 'ITAV' | 'ITBD' | 'OPAV' | 'OPBD' | 'PRCD' | 'XPCD', required — Balance type, in a coded form. <br /> For a full list of enumeration values refer to `ExternalBalanceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
        - `Amount` object, required — Amount of money of the cash balance after a transaction entry is applied to the account..
          - `Amount` string, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
          - `Currency` string, required — 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".
      - `MerchantDetails` OBMerchantDetails1 — Details of the merchant involved in the transaction.
        - `MerchantName` string — Name by which the merchant is known.
        - `MerchantCategoryCode` string — Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
      - `CreditorAgent` OBBranchAndFinancialInstitutionIdentification61 — Financial institution servicing an account for the creditor.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list.<br/> For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of a financial institution or a branch of a financial institution.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `CreditorAccount` OBCashAccount60 — Unambiguous identification of the account of the creditor, in the case of a debit transaction.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Identification assigned by an institution to identify an account. This identification is known by the account owner.
        - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> 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 — Type of the proxy identification.
      - `DebtorAgent` OBBranchAndFinancialInstitutionIdentification62 — Financial institution servicing an account for the debtor.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list.<br/> For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of a financial institution or a branch of a financial institution.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `DebtorAccount` OBCashAccount61 — Unambiguous identification of the account of the debtor, in the case of a credit transaction.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Identification assigned by an institution to identify an account. This identification is known by the account owner.
        - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account.
        - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
        - `Proxy` OBProxy1 — Specifies an alternate assumed name for the identification of the account.
          - `Identification` string, required — Identification used to indicate the account identification under another specified name.
          - `Code` 'TELE' | 'EMAL' | 'DNAM' | 'CINC' | 'COTX' | 'COID' | 'CUST' | 'DRLC' | 'EIDN' | 'EWAL' | 'PVTX' | 'LEIC' | 'MBNO' | 'NIDN' | 'CCPT' | 'SHID' | 'SOSE' | 'TOKN' | 'UBIL' | 'VIPN' | 'BIID', required — Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> 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 — Type of the proxy identification.
      - `CardInstrument` OBTransactionCardInstrument1 — Set of elements to describe the card instrument used in the transaction. <br /> For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `CardSchemeName` 'AmericanExpress' | 'Diners' | 'Discover' | 'MasterCard' | 'VISA', required — Name of the card scheme. <br /> For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `AuthorisationType` 'ConsumerDevice' | 'Contactless' | 'None' | 'PIN' — The card authorisation type. <br /> For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Name` string — Name of the cardholder using the card instrument.
        - `Identification` string — 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.
      - `SupplementaryData` OBSupplementaryData1 — Additional information that can not be captured in the structured fields and/or any other specific block.
      - `CategoryPurposeCode` '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' — 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)
      - `PaymentPurposeCode` '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' — For a full list of enumeration values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      - `UltimateCreditor` OBUltimateCreditor1 — Ultimate party to which an amount of money is due.
        - `Name` string — Name by which a party is known and which is usually used to identify that party.
        - `Identification` string — Identification assigned by an institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `UltimateDebtor` OBUltimateDebtor1 — Ultimate party that owes an amount of money to the (ultimate) creditor.
        - `Name` string — Name by which a party is known and which is usually used to identify that party.
        - `Identification` string — Identification assigned by an institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
      - `IntermediaryAgent1` OBIntermediaryAgent — The intermediary agent associated with this transaction.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of a financial institution or a branch of a financial institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
        - `ProcessingStatus` 'PDNG' | 'RCVD' | 'ACSP' | 'ACSC' | 'RJCT' | 'UNKN' | 'CANC' — 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)
      - `IntermediaryAgent2` OBIntermediaryAgent — The intermediary agent associated with this transaction.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of a financial institution or a branch of a financial institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
        - `ProcessingStatus` 'PDNG' | 'RCVD' | 'ACSP' | 'ACSC' | 'RJCT' | 'UNKN' | 'CANC' — 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)
      - `IntermediaryAgent3` OBIntermediaryAgent — The intermediary agent associated with this transaction.
        - `Name` string — Name by which an agent is known and which is usually used to identify that agent.
        - `SchemeName` string — Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
        - `Identification` string — Unique and unambiguous identification of a financial institution or a branch of a financial institution.
        - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
        - `PostalAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services.
          - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
          - `Department` string — Identification of a division of a large organisation or building.
          - `SubDepartment` string — Identification of a sub-division of a large organisation or building.
          - `StreetName` string — Name of a street or thoroughfare.
          - `BuildingNumber` string — Number that identifies the position of a building on a street.
          - `BuildingName` string — Name of a referenced building.
          - `Floor` string — Number that identifies the level within a building
          - `UnitNumber` string — Number that identifies the unit of a specific address .
          - `Room` string — Information that locates and identifies a room to form part of an address
          - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
          - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address
          - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual.
          - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
          - `TownName` string — Name of a built-up area, with defined boundaries, and a local government.
          - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county.
          - `Country` string — Nation with its own government.
          - `AddressLine` string[]
        - `ProcessingStatus` 'PDNG' | 'RCVD' | 'ACSP' | 'ACSC' | 'RJCT' | 'UNKN' | 'CANC' — 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)
  - `Links` Links — Links relevant to the payload
    - `Self` string, uri, required
    - `First` string, uri
    - `Prev` string, uri
    - `Next` string, uri
    - `Last` string, uri
  - `Meta` Meta — Meta Data relevant to the payload
    - `TotalPages` integer
    - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
    - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/account-and-transaction-api-specification/revisions/b1c449c8ecb0/schema)