--- title: "Get transactions by user" method: GET path: "/data/transactions" --- # Get transactions by user `GET /data/transactions` ## Request - Base URL: `https://api.open-finance.ai/v2` - URL: `https://api.open-finance.ai/v2/data/transactions` - Auth: OAuth 2 - Client credentials - Token URL: `https://api.open-finance.ai/oauth/token` scopes: `read:transactions` ## Query parameters - `nextPage` string - `limit` number - `dateFrom` string - `dateTo` string - `includeDuplicates` 0 | 1 - `sort` 1 | -1 - `accountId` string - `connectionId` string - `type` 'BANK' | 'CARD' - `providerId` 'yahav-sandbox' | 'yahav' | 'undefined' | 'ubank-sandbox' | 'ubank' | 'pepper' | 'pagi-sandbox' | 'pagi' | 'otsarHahayal-sandbox' | 'otsarHahayal' | 'open-finance-sandbox' | 'open-finance-card-sandbox' | 'mizrahi-sandbox' | 'mizrahi' | 'mercantile-sandbox' | 'mercantile' | 'menora-sandbox' | 'max-sandbox' | 'max' | 'masad-sandbox' | 'masad' | 'leumi-sandbox' | 'leumi' | 'isracard-sandbox' | 'isracard' | 'hapoalim-sandbox' | 'hapoalim' | 'discount-sandbox' | 'discount' | 'cal-sandbox' | 'cal' | 'beinleumi-sandbox' | 'beinleumi' | 'americanExpress' ## Response `200` Response - object - `nextPage` string, nullable: Represents the total number of items that exists after full pagination. The max transactions per request is 500 - `items` Transaction[] - `id` string: A unique identifier for the transaction - `SK` string: Secondary key for the transaction, indicating the specific type of transaction and related metadata. - `userId` string: A unique identifier for the user - `orgId` string: A unique identifier for the organization - `connectionId` string: A unique identifier for the connection - `accountId` string: A unique identifier for the account - `providerId` string: A unique identifier for the provider - `transactionProviderIdentifier` string: A unique identifier for the provider TX - `relatedPaymentId` string: If the transaction is linked to a open-banking payment, its id will be here - `accountNumber` string: A bank account number - `status` string: The transaction status - `entryReference` string: The entry reference sent from the provider - `categoryCode` string: Code representing the category of the transaction (MCC code or other). - `securityDetails` TransactionSecurityDetails - `unitsNumber` number: Nominal or numeric quantification of the financial instrument that has been transferred within this transaction. Negative values indicate that the respective quantity of the financial instrument has been taken from the securities account, positive values indicate that the quantity has been added. - `unitsNominal` Amount - `amount` number: The amount value - `currency` string: The amount currency - `placeOfTrade` object - `marketIdentifierProprietary` string: Proprietary Identifier of the market place. - `mic` string: ISO 10383 code of the market place - `relevantDates` object: At least one of the listed date types must be present. - `effectiveSettlementDate` string, date: The effective settlement date - `performanceDate` string, date: The performance date - `settlementDate` string, date: The settlement date - `valueDate` string, date: The value date - `bookingDate` string, date: The booking date - `transactionsDate` string, date: The transaction date - `orderId` string: Resource Id of the order resource that triggered this transaction, if applicable. - `financialInstrument` object: Financial instrument that was transferred within the transaction. - `isin` string - `name` string - `normalisedPrice` object - `amount` Amount - `amount` number: The amount value - `currency` string: The amount currency - `priceDateTime` string - `priceType` 'BIDE' | 'OFFR' | 'NAVL' | 'CREA' | 'CANC' | 'INTE' | 'SWNG' | 'MIDD' | 'RINV' | 'SWIC' | 'MRKT' | 'INDC' | 'DDVR' | 'ACTU' - `sourceOfPrice` object - `type` 'FUND' | 'LMAR' | 'THEO' | 'VEND' - `mic` string - `unitsNumber` number - `balanceType` 'AVAI' | 'AWAS' | 'BTRA' | 'BLOK' | 'BLOV' | 'BLCA' | 'BLOT' | 'BORR' | 'COLI' | 'COLO' | 'MARG' | 'DRAW' | 'COLA' | 'TRAN' | 'ISSU' | 'DIRT' | 'LOAN' | 'REGO' | 'BODE' | 'BORE' | 'PEDA' | 'PECA' | 'PEND' | 'PDMT' | 'PDUM' | 'LODE' | 'LORE' | 'PENR' | 'PRMT' | 'PRUM' | 'PLED' | 'QUAS' | 'NOMI' | 'RSTR' | 'SPOS' | 'CLEN' | 'OTHR' | 'UNRG' | 'WDOC' - `averageBuyingPrice` Amount - `amount` number: The amount value - `currency` string: The amount currency - `details` string - `transactionTypeCode` string: Type of the transaction as code or as a proprietary string. For the code, the following values are supported: BOLE Transaction relates to lending/borrowing. CLAI Transaction relates to a market claim following a corporate action. COLL Transaction relates to collateral. CORP Transaction relates to corporate action. SETT Transaction relates to settlement and clearing. - `transactionTypeProperty` string: Type of the transaction as code or as a proprietary string. For the code, the following values are supported: BOLE Transaction relates to lending/borrowing. CLAI Transaction relates to a market claim following a corporate action. COLL Transaction relates to collateral. CORP Transaction relates to corporate action. SETT Transaction relates to settlement and clearing. - `amountIncludesFees` boolean: Indicates whether the transactionAmount is including fees - `amountIncludesTaxes` boolean: Indicates whether the transactionAmount is including taxes - `relatedFees` RelatedFee[]: Only allowed if amountIncludesFees = true. In that case Details of the fees that have been applied to this transaction (and therefore represent additional costs of the transaction beyond the transactionAmount). Fees with positive amount are debited by the PSU, only in the rare case of a fee credited to the PSU (e.g. in case of a reversal) negative amounts are used. - `amount` Amount - `amount` number: The amount value - `currency` string: The amount currency - `typeCode` 'transactionFee' | 'brokerageFee' | 'managementFee' | 'courtage' | 'custodyFee' | 'exchangeFee' | 'thirdPartyFee' | 'otherFee': Initially, the following codes are defined to indicate different fee types in the context of Securities transactions. Please note, that these codes are not based on an ISO code list and might be changed in later versions of this document: transactionFee, brokerageFee, managementFee, courtage, custodyFee, exchangeFee, thirdPartyFee, otherFee - `typeProprietary` string: Proprietary fee type - `feeType` string: The type of the fee - `_links` object - `self` object - `href` string - `reversalIndicator` boolean: Indicates whether it is the reversal of a previously reported movement. - `reversedTransactionId` string: transactionId of the reversed transaction, if applicable and supported by the ASPSP. - `unitsNumberBeforeTx` number: Nominal or numeric quantification of the financial instrument that has been transferred within this transaction before this transaction has been executed. Negative values indicate that the respective quantity of the financial instrument has been taken from the securities account, positive values indicate that the quantity has been added. - `unitsNominalBeforeTx` Amount - `amount` number: The amount value - `currency` string: The amount currency - `unitsNumberAfterTx` number: Nominal or numeric quantification of the financial instrument that has been transferred within this transaction after this transaction has been executed. Negative values indicate that the respective quantity of the financial instrument has been taken from the securities account, positive values indicate that the quantity has been added. - `unitsNominalAfterTx` Amount - `amount` number: The amount value - `currency` string: The amount currency - `accruedInterest` AccruedInterest - `daysAccrued` number: Specifies the number of days used for calculating the accrued interest amount. - `amounts` Amount[]: Amount of the accrued interest. Each item represents the same monetary value in different currencies, e.g. account currency, currency of the security's denomination. - `amount` number: The amount value - `currency` string: The amount currency - `details` string: Additional details related to the transaction. - `amount` object - `originalAmount` Amount - `amount` number: The amount value - `currency` string: The amount currency - `chargedAmount` Amount - `amount` number: The amount value - `currency` string: The amount currency - `description` object - `description` string: The TX description - `additionalInfo` string: Any additional TX info - `category` object: Categorized TX label - `main` string: Main category - `sub` string: Subcategory - `changedCategory` object: Details about the changed category of the transaction. - `main` string: Main changed category - `sub` string: Sub changed category - `installments` object: Details about installments. - `number` number: The current installment number - `total` number: The total number of installments - `type` string: Transaction type, NORMAL or INSTALLMENT - `date` object - `valueDate` string, date - `bookingDate` string, date - `transactionDate` string, date - `markupFee` object - `amount` number: The amount of the markup fee. - `currency` string: The currency of the markup fee. - `merchantName` string: The name of the merchant involved in the transaction. - `details` string: Detailed information about the transaction. - `isInvoiced` boolean: Indicates whether the transaction is invoiced. - `code` string: A code representing the transaction. - `merchantAddress` object - `streetName` string: The street name of the merchant. - `buildingNumber` string: The building number of the merchant. - `townName` string: The town name of the merchant. - `postCode` string: The postal code of the merchant. - `country` string: The country of the merchant. - `classification` object: Details about the classification of the transaction. - `type` string: The type of classification (e.g., REGULAR_EXPENSE). - `source` string: The source of classification (e.g., SYSTEM). - `changedClassification` object: Details about any changes in the classification of the transaction. - `type` string: The type of classification (e.g., REGULAR_EXPENSE). - `source` string: The source of classification (e.g., USER). - `labels` string[]: Labels associated with the transaction. - `balancePerEndDay` number: The balance at the end of the day for the transaction. - `isDuplicate` boolean: Indicates if the transaction is a duplicate - when a user connects the same credit card from a bank provider and from a credit card when not send includeDuplicates filter the default will be that no duplicate transactions will be returned if the transactions for the user contains more than 500 items, duplicates will be returned regardless of the used filters - `creditorAccount` object - `iban` string: IBAN of the creditor account - `bban` string: BBAN of the creditor account - `maskedPan` string: Masked PAN of the creditor account - `msisdn` string: MSISDN of the creditor account - `currency` string: Currency of the creditor account - `other` string: Other of the creditor account - `cashAccountType` string: Type of the creditor account - `debtorAccount` object - `iban` string: IBAN of the debtor account - `bban` string: BBAN of the debtor account - `maskedPan` string: Masked PAN of the debtor account - `msisdn` string: MSISDN of the debtor account - `currency` string: Currency of the debtor account - `other` string: Other of the debtor account - `cashAccountType` string: Type of the debtor account - `endToEndId` string: The end-to-end identifier of the transaction. This field is crucial for transferring the reference number of the payment, ensuring traceability and consistency across different financial institutions and systems. ## Other responses - `400`: userId is not allowed in query for non-admin users - `401`: Unauthorized access - Invalid access token - `403`: Forbidden - Access token missing the required permissions to preform this action - `404`: Route or entity not found - `500`: Internal server error --- [API](https://skmtc.dev/open-finance/apis/data.md) - [All operations](https://skmtc.dev/open-finance/apis/data/llms.txt) - [OpenAPI document](https://skmtc.dev/open-finance/apis/data/revisions/c18eafb2a770?raw)