getAccountTransactions

GET https://api.finicity.com/financialdatafeed/v1/accounts/:account_Id/transactions?txnStartDate=dateTime[&txnEndDate=dateTime]

This call retrieves all transactions for an account over the specified date range.

Please refer to Authentication Header Attributes for request header attributes and the Response Codes for details about possible success/error status codes.

IMPORTANT:

If the refresh fails, the TransactionList is still returned but the details of the failure will appear in the notRefreshedReason attribute of the TransactionList entity.

Pending transactions are ephemeral and don't have permanent transaction IDs. It is recommended that the developers clear them during every refresh. Pending transactions will eventually get posted in the Financial Institution and will be available as a new transaction in the Financial Data API.

Query Parameters

Attribute Data Type Required Description
accountId Long Required Unique identifier for an account.
txnStartDate String Required Posted date - Begin-date. Format: YYYY-MM-DD
txnEndDate String Optional Posted date - End-date. Format: YYYY-MM-DD

Transaction Response Attributes

Attribute Data Type Description Frequent?
id Long Unique identifier for an account transaction. Yes
currencyType CurrencyCode  ISO 4217 Currency Code enumeration  
institutionTransactionId String  Transaction ID issued by the Financial Institution.  Yes 
correctInstitutionTransactionId String  This attribute can be ignored and holds the same value as  institutionTransactionId.  
correctAction String  This attribute designates when a transaction is a replacement of another transaction or has been deleted from the institution's website. E.g. R - Replace, D - Delete, O - Obsolete.  
checkNumber String   Check number as available in the Financial Institution.  
refNumber String   The receipt/acknowledgement number for a transaction in the Financial Institution.  
confirmationNumber String   This number is generated by Financial Institutions to track the status of a transaction.  
payeeId String   A unique payee identifier within the Financial Institution.  
payeeName String   The description of the transaction. It may include the name of the payee. Yes
extendedPayeeName String   Extended name of the payee or description of the transaction.  
memo String   Description of the transaction. Yes
type String   Type of transaction, E.g. Credit, Debit etc. Yes 
valueType String   Value-type of a transaction. E.g. Purchase requisition, Purchase order, Travel commitment, Invoice, Payment, Down payment request, Parked documents, Down payment, Funds transfers, Funds commitments, Transfer Posting, Funds block, Funds reservations, Funds pre-commitments, Forecast of revenue, Secondary cost postings. Yes 
currencyRate Decimal  The exchange rate as it is available in the Financial Institution.  
originalCurrency Boolean  Indicates whether currency conversion is required (Y/N).  
postedDate DateTime  Date when the transaction was posted in the Financial Institution. Yes
userDate DateTime  This date is the same as posted date. It is used for pending transactions. Yes 
availableDate DateTime  Date when the transactions were pulled from the Financial Institution's Website by Finicity.  
amount Decimal  Amount in this transaction. Yes 
runningBalanceAmount Decimal  A running balance is the total of funds available in a given credit or debit account. Yes
pending Boolean  true/false - This indicates if it's a posted or a pending transaction. Yes 
categorization Header tag  (Parent attribute)
A value "common" refers to an un-categorized transaction.
 
- common Header tag  common is the default type of Categorization. This is returned when Categorization is not enabled.  
- - normalizedPayeeName String  Categorization. Name of the payee. This is extracted by Finicity's data enrichment processes. Yes
- - sic Integer  Categorization. Standard Industrial Classification (SIC) code.  
- context Header tag  Categorization. Provides contextual information of the transaction.   
- - categoryName String Categorization. Category name of the transaction. Yes
- - scheduleC String  Categorization. Category as per Schedule C Tax form. Yes 

Additional Investment Transaction Attributes

Attribute Data Type Description Frequent?
bankingTransactionType String Type of Banking transaction Yes
subaccountFundType InvestmentSubaccountType Type of Investment Account. E.g. CASH, MARGIN, SHORT, OTHER.  
banking401KSourceType String Type of the 401K source. E.g. PREGAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST.  

Additional Loan Transaction Attributes

Attribute Data Type Description Frequent?
principalAmount Decimal Payment amount made towards loan principal. Yes
interestAmount Decimal Payment amount made towards loan interest.  
escrowTotalAmount Decimal Amount paid towards escrow payments of the loan. Escrow is money that the mortgage company is holding to pay loan holder's property taxes, homeowner's insurance, and/or mortgage insurance.  
escrowTaxAmount Decimal Property tax amount part ofescrowTotalAmount.  
escrowInsuranceAmount Decimal Homeowner's Insurance amount part of escrowTotalAmount.  
escrowPmiAmount Decimal Private Mortgage Insurance part of  escrowTotalAmount.  
escrowFeesAmount Decimal Escrow fees paid as part of this transaction.  
escrowOtherAmount Decimal Escrow amount paid for items other than taxes and insurance.  

Other Investment Attributes fetched along with Investment Transaction Attributes

Attribute Data Type Description Frequent?
reveralInstitutionTransactionId String institutionTransactionId (Financial Institution transaction id) for a related trade.  
description String Description of the investment transaction.  
buyType String Type of investment Buy. E.g. BUY, BUYTOCOVER.  
incomeType String Type of investment income. E.g. CGSHORT (Capital gains short-term), CGLONG (Capital gains long-term), DIV (dividend), INTEREST, MISC, etc.  
inv401kSource String Source of money for a 401K-Investment transaction. This applies in 401K loan disbursement and re-payment. E.g. PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST, etc.  
loanId String Unique loan identifier in the Financial Institution. Yes
optionsActionType String Investment action performed on an Option. E.g. EXERCISE, ASSIGN, EXPIRE.  
optionsBuyType String Buy type for an option security. E.g. BUYTOOPEN, BUYTOCLOSE.  
optionsSellType String Sell type for an option security. E.g. SELLTOOPEN, SELLTOCLOSE.  
positionType String  Type of investment position. E.g. LONG, SHORT.  
relatedInstitutionTradeId String  The Institution Trade ID that brought in funds used in the transaction (Buy/Sell).  
relatedOptionTransType String  Related options transfer type. E.g. SPREAD, STRADDLE, NONE, OTHER, etc.  
securedType String  This indicates how an option is secured. E.g. NAKED, COVERED.  
sellReason String  Reason the "sell" of a debt security was generated. E.g. CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity).  
sellType String  Type of "sell". E.g. SELL, SELLSHORT.  
subaccountFromType String  Sub-account type that the security or cash is transferred from. E.g. CASH, MARGIN, SHORT, OTHER.  
subaccountFundType String  Fund-type of the sub-account where the security or cash is transferred from. E.g. CASH, MARGIN, SHORT, OTHER.  
subaccountSecurityType String  Sub-account security type of the investment account. E.g. CASH, MARGIN, SHORT, OTHER.  
subaccountToType String  Sub-account type that security or cash is transferred to. E.g. CASH, MARGIN, SHORT, OTHER.  
transferAction String  Transfer action of the transaction. E.g. IN, OUT.  
unitType String  Type of units involved in the transaction. E.g. SHARES, CURRENCY.  
cusip String  Number assigned by CUSIP - Committee on Uniform Securities Identifications Procedure.  
symbol String  Ticker symbol of an equity.  
unitAction String  Action type of the transaction. E.g. EXERCISE, ASSIGN, EXPIRE.  
tradeDate DateTime Trade date of this transaction.  
settleDate DateTime  Settlement date of the transaction.  
accruedInterestAmount Decimal  Interest amount accrued.  
averageCostBasisAmount Decimal  Average cost-basis of the equity involved in this transaction.  
commisionAmount Decimal  Amount incurred on paying commissions.  
denominator Decimal  This applies for stock splits. This refers to the quantity in the split-ratio denominator.  
payrollDate DateTime  Payroll date. This is used in Employer-sponsored investment contributions. E.g. 401-K,ESPP, etc.  
purchaseDate DateTime  Date of purchase of the equity.  
gainAmount Decimal This indicates the amount gained in a sale.  
feesAmount Decimal  Amount incurred on fees in a trade.  
fractionalUnitsCashAmount Decimal  This applies for stock splits and refers to the amount used for fractional units.  
loadAmount Decimal  Load amount in a transaction. Load may indicate sales charges in a mutual fund transaction.  
loanInterestAmount Decimal  Interest part of the loan.  
loanPrincipalAmount Decimal  Principal part of the loan  
markdownAmount Decimal  Portion of the unit price that is attributed to the dealer markdown.  
markupAmount Decimal  Portion of the unit price that is attributed to the dealer markup.  
newUnits Decimal  Number of shares after a stock split.  
numerator Decimal  This applies for stock splits. It refers to the quantity in the split-ratio numerator.  
oldUnits Decimal  Number of shares before a stock-split.  
penaltyAmount Decimal  Penalty amount charged as part of this transaction.  
priorYearContribution Boolean This applies for investment transactions that was made with a prior year contribution. This is a flag to indicate that contribution.  
sharesPerContract Short This applies for trades other than options and indicates shares per security contract.  
stateWithholding Decimal  Amount withheld for state taxes.  
totalAmount Decimal  Total amount involved in this transaction.  
taxesAmount Decimal  Amount of tax paid as part of this transaction.  
taxExempt Boolean  This indicates if this transaction is exempted from tax.  
unitPrice Decimal  Price per unit of the equity in the transaction.  
withholdingAmount Decimal  Amount that was withheld for federal taxes.  
optionsSharesPerContract Long  This applies for options. Shares per options contract.  
invSecurityType String  Type of investment security. E.g. MFINFO, STOCKINFO, OPTINFO, DEBTINFO, OTHERINFO, etc. Please refer to Response Attributes of Investment Positions for details on Security Info.  

Sample Responses 

Sample Response With Categorization Disabled - JSON body:

{
    "creditCardTransactions": [
        {
            "id": 400319238524,
            "userDate": 1382425200000,
            "categorization": {
                "context": [],
                "common": {}
            },
            "currencyType": "USD",
            "payeeName": "CREDITCARD credit 295",
            "amount": 10.22,
            "pending": true
        },
        {
            "id": 400319238525,
            "userDate": 1382425200000,
            "categorization": {
                "context": [],
                "common": {}
            },
            "currencyType": "USD",
            "payeeName": "CREDITCARD debit 294",
            "amount": -10.21,
            "pending": true
        }
    ],
    "notRefreshedReason": "NOT_NECESSARY"
}

Sample Response With Categorization Enabled - JSON body:

{
    "TransactionList": {
        "LoanTransaction": [
            {
                "id": "75343192592",
                "currencyType": "USD",
                "institutionTransactionId": "0003452731",
                "payeeName": "target costco Loan credit 135",
                "postedDate": "2015-05-15T00:00:00-07:00",
                "userDate": "2015-05-15T00:00:00-07:00",
                "amount": "5.15",
                "pending": "false",
                "categorization": {}
            },
            {
                "id": "75343462562",
                "currencyType": "USD",
                "payeeName": "target costco Loan credit 147",
                "userDate": "2015-05-27T00:00:00-07:00",
                "amount": "5.27",
                "pending": "true",
                "categorization": {
                    "common": {
                        "normalizedPayeeName": "Target Costco Loan"
                    },
                    "context": {
                        "source": "CAT",
                        "categoryName": "Loans",
                        "scheduleC": "Business Loan"
                    }
                }
            },
            {
                "id": "75343462563",
                "currencyType": "USD",
                "payeeName": "target costco Loan debit 146",
                "userDate": "2015-05-27T00:00:00-07:00",
                "amount": "-5.26",
                "pending": "true",
                "categorization": {
                    "common": {
                        "normalizedPayeeName": "Target",
                        "sic": "531102"
                    },
                    "context": {
                        "source": "CAT",
                        "categoryName": "Shopping",
                        "scheduleC": "Other Business Expenses"
                    }
                }
            }
        ]
    }
}

Sample Response With Categorization Disabled - XML body: 

<ns9:TransactionList xmlns="http://schema.intuit.com/platform/fdatafeed/transaction/v1"
    xmlns:ns2="http://schema.intuit.com/platform/fdatafeed/bnktransaction/v1"
    xmlns:ns3="http://schema.intuit.com/platform/fdatafeed/cctransaction/v1"
    xmlns:ns4="http://schema.intuit.com/platform/fdatafeed/ibnktransaction/v1"
    xmlns:ns5="http://schema.intuit.com/platform/fdatafeed/loantransaction/v1"
    xmlns:ns6="http://schema.intuit.com/platform/fdatafeed/invtransaction/v1"
    xmlns:ns7="http://schema.intuit.com/platform/fdatafeed/securityinfo/v1"
    xmlns:ns8="http://schema.intuit.com/platform/fdatafeed/rewardstransaction/v1"
    xmlns:ns9="http://schema.intuit.com/platform/fdatafeed/transactionlist/v1"
    notRefreshedReason="NOT_NECESSARY">
    <ns3:CreditCardTransaction>
        <id>400319238524</id>
        <currencyType>USD</currencyType>
        <payeeName>CREDITCARD credit 295</payeeName>
        <userDate>2014-10-22T00:00:00-07:00</userDate>
        <amount>10.22</amount>
        <pending>true</pending>
        <categorization>
            <common/>
        </categorization>
    </ns3:CreditCardTransaction>
    <ns3:CreditCardTransaction>
        <id>400319238525</id>
        <currencyType>USD</currencyType>
        <payeeName>CREDITCARD debit 294</payeeName>
        <userDate>2013-10-22T00:00:00-07:00</userDate>
        <amount>-10.21</amount>
        <pending>true</pending>
        <categorization>
            <common/>
        </categorization>
    </ns3:CreditCardTransaction>
</ns9:TransactionList>

Sample Response With Categorization Enabled - XML body:

<ns9:TransactionList xmlns="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns2="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns3="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns4="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns5="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns6="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns7="http://schema.intuit.com/platform/fd...ecurityinfo/v1"
xmlns:ns8="http://schema.intuit.com/platform/fd...transaction/v1"
xmlns:ns9="http://schema.intuit.com/platform/fd...sactionlist/v1"
notRefreshedReason="NOT_NECESSARY">
<ns5:LoanTransaction> <id>75343192592</id> <currencyType>USD</currencyType> <institutionTransactionId>0002453712</institutionTransactionId> <payeeName>target costco Loan credit 135</payeeName> <postedDate>2015-05-15T00:00:00-07:00</postedDate> <userDate>2015-05-15T00:00:00-07:00</userDate> <amount>5.15</amount> <pending>false</pending> <categorization> <common/> </categorization> </ns5:LoanTransaction> <ns5:LoanTransaction> <id>75343462562</id> <currencyType>USD</currencyType> <payeeName>target costco Loan credit 147</payeeName> <userDate>2015-05-27T00:00:00-07:00</userDate> <amount>5.27</amount> <pending>true</pending> <categorization> <common> <normalizedPayeeName>Target Costco Loan</normalizedPayeeName> </common> <context> <source>CAT</source> <categoryName>Loans</categoryName> <scheduleC>Business Loan</scheduleC> </context> </categorization> </ns5:LoanTransaction> <ns5:LoanTransaction> <id>75343462563</id> <currencyType>USD</currencyType> <payeeName>target costco Loan debit 146</payeeName> <userDate>2015-05-27T00:00:00-07:00</userDate> <amount>-5.26</amount> <pending>true</pending> <categorization> <common> <normalizedPayeeName>Target</normalizedPayeeName> <sic>531102</sic> </common> <context> <source>CAT</source> <categoryName>Shopping</categoryName> <scheduleC>Other Business Expenses</scheduleC> </context> </categorization> </ns5:LoanTransaction> </ns9:TransactionList>

Schema Files (TO-DO)

  • BankingTransaction_1.xsd
  • CreditCardTransaction_1.xsd
  • InvestmentBankingTransaction_1.xsd
  • InvestmentTransaction_1.xsd
  • LoanTransaction_1.xsd
  • RewardsTransaction_1.xsd
  • Transaction_1.xsd
  • TransactionList_1.xsd

 

Have more questions? Submit a request

Comments

Powered by Zendesk