getCustomerAccounts

GET https://api.finicity.com/financialdatafeed/v1/accounts

This call returns a list of all accounts belonging to the authenticated user making the call.

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

Account Attributes

The following account attributes apply to all types of accounts:

Attribute Data Type Description Frequent?
accountId Long

Finicity identifier of an account.

Yes
status String Status of an account. ACTIVE/INACTIVE. Yes
accountNickname String Nickname of the Account - retrieved from the Financial Institution.  
displayPosition Int The Nth position of the account within the user's Financial Institution. E.g. For an end-user with 3 accounts in a Financial Institution, the values for those three accounts would be 1,2,3 depending on the order it appears in the Financial Institution's website.  
institutionId Long Unique identifier for a Financial Institution. This is the same as the one sent in the request. Yes
description String Description of the account.  
balanceAmount Decimal Current balance of the account. This is also referred as ledger balance. This doesn't include "pending" or "hold" transactions. Yes
balanceDate Date Date when the current balance was calculated.  
balancePreviousAmount Decimal

Previous balance of the account.

 
lastTxnDate Date Last transaction date of the account in the Financial Data API.  
aggrSuccessDate Unix Timestamp Date on which the account's transaction history was last successfully refreshed from the Financial Institution. Yes
aggrAttemptDate Unix Timestamp Date on which the Financial Data API attempted the last refresh of this account from the Financial Institution. Yes 
aggrStatusCode String

Return code of the last refresh attempt. It is recommended that the developers look into this value. A non-zero value in this attribute indicates that the Financial Data API may not have the most updated information from the Financial Institution.

0 - Success or Other Error codes.

Yes 
currencyCode CurrencyCode ISO 4217 Currency Code enumeration  
institutionLoginId Long Unique identifier for a customer's login details in a Financial Institution. Yes 

Banking Account Attributes

Attribute Data Type Description Frequent?
bankingAccountType String Type of Banking Account. E.g. CHECKING, SAVINGS, MONEYMRKT, RECURRINGDEPOSIT, CD, CASHMANAGEMENT, OVERDRAFT etc. Yes
postedDate DateTime Date when account transactions were refreshed.  
availableBalanceAmount Decimal Available balance of the account. This may include "pending" and "hold" transactions. Pending transactions and related details are not available from all Financial Institutions. Yes
interestType String Interest type used by the Financial Institution.  
originationDate DateTime Origination date of the account.  
openDate DateTime Date the account was opened in the Financial Institution.  
periodInterestRate Decimal The interest rate given for amount deposited for a fixed period of time.  
periodDepositAmount Decimal Deposit amount for the specified period.  
periodInterestAmount Decimal Interest amount over the specified period.  
interestAmountYtd Decimal  Year-to-date interest amount.  
interestPriorAmountYtd Decimal  Last year-to-date interest amount.  
maturityDate DateTime  Maturity date of the current period deposit.  
maturityAmount Decimal  Maturity amount.  

Credit Account Attributes

Attribute Data Type Description Frequent?
creditAccountType String Type of the credit account. E.g. CREDITCARD, LINEOFCREDIT, OTHER etc. Yes
detailedDescription String Description of the account.  
interestRate Decimal Interest rate or APR on the credit card.  
creditAvailableAmount Decimal Available amount on the account. Yes
creditMaxAmount Decimal Max credit limit of the account.  
cashAdvanceAvailableAmount Decimal Amount available for cash advances.  
cashAdvanceMaxAmount Decimal Maximum amount available for cash advances.  
cashAdvanceBalance Decimal Balance available for cash advances.  
cashAdvanceInterestRate Decimal Rate of interest for cash advances.  
currentBalance Decimal  Current outstanding balance of the account.  
paymentMinAmount Decimal  Minimum payment amount for the current billing cycle. Yes
paymentDueDate DateTime  Date minimum payment is due. Yes
previousBalance Decimal  Account balance during the previous billing cycle.  
statementEndDate DateTime  End-date of a billing statement.  
statementPurchaseAmount Decimal  Purchase amount from the last statement.  
statementFinanceAmount Decimal  Finance amount from the last statement.  
pastDueAmount Decimal  Amount due from prior billing cycle.  
lastPaymentAmount Decimal  Amount of last payment applied to account.  
lastPaymentDate DateTime  Last payment date.   
statementCloseBalance Decimal  Closing balance from the last statement.  
statementLateFeeAmount Decimal  Late Fee amount from the last statement.  

Loan Account Attributes

Attribute Data Type Description Frequent?
loanDescription String Description of the loan.  
loanType LoanType Type of Loan Account E.g. AUTO, COMMERCIAL, CONSTR, CONSUMER, HOMEEQUITY, MILITARY, MORTGAGE, SMB, STUDENT etc.  
postedDate DateTime Date when account transactions were refreshed.  
term String The tenure of loan.  
lateFeeAmount Decimal Late fee amount on this loan account.  
payoffAmount Decimal Loan payoff amount.  
payoffAmountDate DateTime Date when the loan was paid off.  
referenceNumber String Loan application reference number.  
originalMaturityDate DateTime Original maturity date of this loan account.  
taxPayeeName String  Tax payee name linked to this loan account.  
principalBalance Decimal  Amount of loan remaining unpaid, not including interest and other charges.     
escrowBalance Decimal  Escrow balance of this loan account.   
interestRate Decimal  Interest rate on the loan.  
interestPeriod String  Interest period of the loan.   
initialAmount Decimal  The initial loan amount in the loan account.   
initialDate DateTime  The date on which the initial loan amount in the loan account was issued   
nextPaymentPrincipalAmount Decimal  Principal amount to be paid by the next payment date.  
nextPaymentInterestAmount Decimal  Interest amount to be paid by the next payment date.  
nextPayment Decimal The next payment amount.  
nextPaymentDate Decimal  The next payment date. Yes 
lastPaymentDueDate DateTime  Date on which the last payment was due.  
lastPaymentReceiveDate DateTime  Actual date on which the last payment was received. Yes 
lastPaymentAmount Decimal  Amount of the last payment applied to the account. Yes 
lastPaymentPrincipalAmount Decimal  Principal amount in the last payment.  
lastPaymentInterestAmount Decimal  Interest amount in the last payment.  
lastPaymentEscrowAmount Decimal  Escrow amount in the last payment.  
lastPaymentLastFeeAmount Decimal  Fee amount in the last payment.  
lastPaymentLateCharge Decimal  Late fee in the last payment.  
principalPaidYTD Decimal  Principal payments, year-to-date.   
interestPaidYTD Decimal  Interest paid, year-to-date.  
insurancePaidYTD Decimal  Insurance amount paid, year-to-date.   
taxPaidYTD Decimal  Tax paid, year-to-date.  
autoPayEnrolled Boolean  Indicates whether the account is enrolled in the Financial Institution's auto-pay feature.  
collateral String  Collateral information on this loan.  
currentSchool String  School details for a student loan.  
firstPaymentDate DateTime  Payment date for the first installment paid towards the loan taken.  
firstMortgage Boolean  A flag which indicates if the loan is the first mortgage taken by the borrower. Values: Y/N.  
loanPaymentFreq String  Payment frequency details. E.g. Monthly, Weekly, Bi-Monthly etc.  
paymentMinAmount Decimal  Minimum payment amount.  
originalSchool String  School (prior) details for a student loan.  
recurringPaymentAmount Decimal  Recurring payment amount.  
lender String  Name of the lending institution.  
endingBalanceAmount Decimal  Balance amount - includes any pending transactions.  
availableBalanceAmount Decimal  Amount of funds in your account that can be accessed immediately.  
loanTermType LoanTermType  Type of the loan term. E.g. COMBO, FIXED, REVOLVE, OPEN.  
noOfPayments Int  Number of payments made towards the loan account.  
balloonAmount Decimal  A lump sum payment that is attached to a loan.  
projectedInterest Decimal  Interest rates in future - forecasted.  
interestPaidLtd Decimal  Interest paid - loan-to-date.  
interestRateType RateType  Interest type used by the Financial Institution E.g. FIXED, FLOATING, ARM etc. Yes
loanPaymentType PaymentType  Type of the loan payment. E.g. INT_ONLY (Interest Only) etc.  
remainingPayments Int Number of installments remaining towards the closure of loan.   

Investment Account Attributes

Attribute Data Type Description Frequent?
investmentAccountType Decimal Type of investment account. E.g. 401K, BROKERAGE, IRA, 403B, KEOGH, TRUST, TDA, SIMPLE, NORMAL, SARSEP, UGMA etc. Yes
interestMarginBalance Decimal Balance in the margin interest expense.  
shortBalance Decimal Balance in a short position account.  
availableCashBalance Decimal Available cash balance.  
currentBalance Decimal Current balance.  
maturityValueAmount Decimal Value of the security at its maturity.  
unvestedBalance Decimal Unvested balance in the account.  
vestedBalance Decimal Vested balance in the account.  
empMatchDeferAmount Decimal Deferred amount in Employer matching contribution.  
empMatchDeferAmountYtd Decimal  Year-to-date empMatchDeferAmount.  
empMatchAmount Decimal  Employer matching contribution.  
empMatchAmountYtd Decimal  Year-to-date empMatchAmount.  
empPretaxContribAmount Decimal  Pre-tax employer contribution amount.  
empPretaxContribAmountYtd Decimal  Year-to-date pre-tax employer contribution amount.  
rolloverItd Decimal  Rollover interest-to-date.  
cashBalanceAmount Decimal  Amount available for cash balance.  
initialLoanBalance Decimal  Initial loan balance.  
loanStartDate DateTime Loan start date.  
currentLoanBalance Decimal Current loan balance.  
loanRate Decimal  Loan interest rate or APR.  

Reward Account Attributes

Reward Accounts are not supported in the Financial Data API Facade.

Sample Responses

Sample Response JSON body

{"accounts": [
  {
"type": "bankingAccount",
"bankingAccountType": "CD",
"currencyCode": "INR",
"accountId": 400005394780,
"accountNumber": "2000005555",
"accountNickname": "My CD",
"displayPosition": 6,
"institutionId": 100000,
"balanceAmount": 1022.26,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
},
{
"type": "bankingAccount",
"bankingAccountType": "SAVINGS",
"currencyCode": "INR",
"accountId": 400005394777,
"accountNumber": "1000002222",
"accountNickname": "My Savings",
"displayPosition": 5,
"institutionId": 100000,
"balanceAmount": 1022.26,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
},
{
"type": "loanAccount",
"loanPaymentFreq": "MONTHLY",
"nextPayment": 1022.26,
"nextPaymentDate": 1585724400000,
"loanType": "LOAN",
"firstPaymentDate": 1585724400000,
"guarantor": "Guarantor",
"collateral": "1022.26",
"currentSchool": "Cur School",
"originalSchool": "Orig School",
"autopayEnrolled": true,
"firstMortgage": false,
"lender": "Lender",
"paymentMinAmount": 1022.26,
"recurringPaymentAmount": 1022.26,
"description": "Description",
"currencyCode": "USD",
"accountId": 400005394775,
"accountNumber": "8000008888",
"accountNickname": "My Auto Loan",
"displayPosition": 1,
"institutionId": 100000,
"balanceAmount": 1022.26,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
},
{
"type": "investmentAccount",
"investmentAccountType": "TAXABLE",
"currentBalance": 1022.26,
"currencyCode": "USD",
"accountId": 400005394778,
"accountNumber": "2000004444",
"accountNickname": "My Roth IRA",
"displayPosition": 3,
"institutionId": 100000,
"balanceAmount": 1022.26,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
},
{
"type": "creditAccount",
"creditAccountType": "LINEOFCREDIT",
"currentBalance": -1022.26,
"currencyCode": "INR",
"accountId": 400005394779,
"accountNumber": "8000006666",
"accountNickname": "My Line of Credit",
"displayPosition": 4,
"institutionId": 100000,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
},
{
"type": "creditAccount",
"statementCloseBalance": -1022.26,
"statementEndDate": 1583049600000,
"creditAccountType": "CREDITCARD",
"currentBalance": -1022.26,
"paymentDueDate": 1585724400000,
"paymentMinAmount": 15,
"currencyCode": "USD",
"accountId": 400005394781,
"accountNumber": "4100007777",
"accountNickname": "My Visa",
"displayPosition": 2,
"institutionId": 100000,
"lastTxnDate": 1382252400000,
"aggrSuccessDate": 1382477168611,
"aggrAttemptDate": 1382477168611,
"aggrStatusCode": "0",
"institutionLoginId": 120910153,
"status": "ACTIVE",
"balanceDate": 1382425200000
}
]}

Sample Response XML body

<ns8:AccountList xmlns="http://schema.intuit.com/platform/fdatafeed/account/v1"
    xmlns:ns2="http://schema.intuit.com/platform/fdatafeed/otheraccount/v1"
    xmlns:ns3="http://schema.intuit.com/platform/fdatafeed/creditaccount/v1"
    xmlns:ns4="http://schema.intuit.com/platform/fdatafeed/loanaccount/v1"
    xmlns:ns5="http://schema.intuit.com/platform/fdatafeed/bankingaccount/v1"
    xmlns:ns6="http://schema.intuit.com/platform/fdatafeed/rewardsaccount/v1"
    xmlns:ns7="http://schema.intuit.com/platform/fdatafeed/investmentaccount/v1"
    xmlns:ns8="http://schema.intuit.com/platform/fdatafeed/accountlist/v1">
<ns3:CreditAccount>
<accountId>400005394781</accountId>
<status>ACTIVE</status>
<accountNumber>4100007777</accountNumber>
<accountNickname>My Visa</accountNickname>
<displayPosition>2</displayPosition>
<institutionId>100000</institutionId>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>USD</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns3:creditAccountType>CREDITCARD</ns3:creditAccountType>
<ns3:currentBalance>-1022.25</ns3:currentBalance>
<ns3:paymentMinAmount>15</ns3:paymentMinAmount>
<ns3:paymentDueDate>2020-04-01T00:00:00-07:00</ns3:paymentDueDate>
<ns3:statementEndDate>2020-03-01T00:00:00-08:00</ns3:statementEndDate>
<ns3:statementCloseBalance>-1022.25</ns3:statementCloseBalance>
</ns3:CreditAccount>
<ns7:InvestmentAccount>
<accountId>400005394778</accountId>
<status>ACTIVE</status>
<accountNumber>2000004444</accountNumber>
<accountNickname>My Roth IRA</accountNickname>
<displayPosition>3</displayPosition>
<institutionId>100000</institutionId>
<balanceAmount>1022.25</balanceAmount>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>USD</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns7:investmentAccountType>TAXABLE</ns7:investmentAccountType>
<ns7:currentBalance>1022.25</ns7:currentBalance>
</ns7:InvestmentAccount>
<ns3:CreditAccount>
<accountId>400005394779</accountId>
<status>ACTIVE</status>
<accountNumber>8000006666</accountNumber>
<accountNickname>My Line of Credit</accountNickname>
<displayPosition>4</displayPosition>
<institutionId>100000</institutionId>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>INR</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns3:creditAccountType>LINEOFCREDIT</ns3:creditAccountType>
<ns3:currentBalance>-1022.25</ns3:currentBalance>
</ns3:CreditAccount>
<ns5:BankingAccount>
<accountId>400005394780</accountId>
<status>ACTIVE</status>
<accountNumber>2000005555</accountNumber>
<accountNickname>My CD</accountNickname>
<displayPosition>6</displayPosition>
<institutionId>100000</institutionId>
<balanceAmount>1022.25</balanceAmount>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>INR</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns5:bankingAccountType>CD</ns5:bankingAccountType>
</ns5:BankingAccount>
<ns4:LoanAccount>
<accountId>400005394775</accountId>
<status>ACTIVE</status>
<accountNumber>8000008888</accountNumber>
<accountNickname>My Auto Loan</accountNickname>
<displayPosition>1</displayPosition>
<institutionId>100000</institutionId>
<description>Description</description>
<balanceAmount>1022.25</balanceAmount>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>USD</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns4:loanType>LOAN</ns4:loanType>
<ns4:nextPayment>1022.25</ns4:nextPayment>
<ns4:nextPaymentDate>2020-04-01T00:00:00-07:00</ns4:nextPaymentDate>
<ns4:autopayEnrolled>true</ns4:autopayEnrolled>
<ns4:collateral>1022.25</ns4:collateral>
<ns4:currentSchool>Cur School</ns4:currentSchool>
<ns4:firstPaymentDate>2020-04-01T00:00:00-07:00</ns4:firstPaymentDate>
<ns4:guarantor>Guarantor</ns4:guarantor>
<ns4:firstMortgage>false</ns4:firstMortgage>
<ns4:loanPaymentFreq>MONTHLY</ns4:loanPaymentFreq>
<ns4:paymentMinAmount>1022.25</ns4:paymentMinAmount>
<ns4:originalSchool>Orig School</ns4:originalSchool>
<ns4:recurringPaymentAmount>1022.25</ns4:recurringPaymentAmount>
<ns4:lender>Lender</ns4:lender>
</ns4:LoanAccount>
<ns5:BankingAccount>
<accountId>400005394777</accountId>
<status>ACTIVE</status>
<accountNumber>1000002222</accountNumber>
<accountNickname>My Savings</accountNickname>
<displayPosition>5</displayPosition>
<institutionId>100000</institutionId>
<balanceAmount>1022.25</balanceAmount>
<balanceDate>2013-10-22T00:00:00-07:00</balanceDate>
<lastTxnDate>2013-10-20T00:00:00-07:00</lastTxnDate>
<aggrSuccessDate>2013-10-22T13:25:14.298-07:00</aggrSuccessDate>
<aggrAttemptDate>2013-10-22T13:25:14.298-07:00</aggrAttemptDate>
<aggrStatusCode>0</aggrStatusCode>
<currencyCode>INR</currencyCode>
<institutionLoginId>120910153</institutionLoginId>
<ns5:bankingAccountType>SAVINGS</ns5:bankingAccountType>
</ns5:BankingAccount>
</ns8:AccountList>

Schema Files (TO-DO)

  • AccountList_1.xsd
  • BankingAccount_1.xsd
  • CreditAccount_1.xsd
  • InvestmentAccount_1.xsd
  • LoanAccount_1.xsd
  • OtherAccount_1.xsd
  • RewardsAccount_1.xsd

 

Have more questions? Submit a request

Comments

Powered by Zendesk