--- title: "GET /fdx/accounts/{accountId}" method: GET path: "/fdx/accounts/{accountId}" --- # GET /fdx/accounts/{accountId} `GET /fdx/accounts/{accountId}` Get account balances and liabilities ## Path parameters - `accountId` string, required ## Response `200` OK - union - object - `depositAccount` object, required — A deposit account. For example, a checking, savings or money market account. - `accountId` string, required — Long-term persistent identity of the account, though not an account number. - `accountNumberDisplay` string — A masked version of the account number, which includes the last 4 digits in plain text. - `productName` string, required — Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum". - `nickname` string — A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection. - `status` 'CLOSED' | 'DELINQUENT' | 'NEGATIVECURRENTBALANCE' | 'OPEN' | 'PAID' | 'PENDINGCLOSE' | 'PENDINGOPEN' | 'RESTRICTED', required - `currency` object, required - `currencyCode` string, required — The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars. - `accountType` 'CHECKING' | 'SAVINGS' | 'CD' | 'ESCROW' | 'MONEYMARKET' | 'OTHERDEPOSIT', required - `currentBalance` number, required — The current balance of the account in the standard unit of the currency (e.g., dollars for USD). Current balance is the balance that is currently in the account, including any pending transactions. - `availableBalance` number, required — The available balance of the account in the standard unit of the currency (e.g., dollars for USD). Available balance is the balance that is available to spend/withdraw. - object - `loanAccount` object, required — A loan account. For example, mortgage, student loan or auto loan. - `accountId` string, required — Long-term persistent identity of the account, though not an account number. - `accountNumberDisplay` string — A masked version of the account number, which includes the last 4 digits in plain text. - `productName` string, required — Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum". - `nickname` string — A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection. - `status` 'CLOSED' | 'DELINQUENT' | 'NEGATIVECURRENTBALANCE' | 'OPEN' | 'PAID' | 'PENDINGCLOSE' | 'PENDINGOPEN' | 'RESTRICTED', required - `currency` object, required - `currencyCode` string, required — The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars. - `accountType` 'AUTOLOAN' | 'HOMEEQUITYLOAN' | 'INSTALLMENT' | 'LOAN' | 'MILITARYLOAN' | 'MORTGAGE' | 'PERSONALLOAN' | 'SMBLOAN' | 'STUDENTLOAN', required - `principalBalance` number, required — The principal balance of the loan account in the standard unit of the currency (e.g., dollars for USD). Principal balance is the amount of the loan that is still owed. - `escrowBalance` number — The escrow balance of the loan account in the standard unit of the currency (e.g., dollars for USD). Escrow balance is the amount of money held in escrow to pay for property taxes and insurance. - `originalPrincipal` number — The original principal balance of the loan account in the standard unit of the currency (e.g., dollars for USD). Original principal balance is the amount of the loan when it was first taken out. - `originatingDate` string — The date the loan was originated. - `loanTerm` string — The term of the loan in months. - `nextPaymentAmount` number — The amount of the next payment due on the loan in the standard unit of the currency (e.g., dollars for USD). - `nextPaymentDate` string — The date the next payment is due. - `lastPaymentAmount` number — The amount of the last payment made on the loan in the standard unit of the currency (e.g., dollars for USD). - `lastPaymentDate` string — The date the last payment was made. - `maturityDate` string — The date the loan is scheduled to be paid off. - `interestPaidYearToDate` number — The amount of interest paid on the loan year-to-date in the standard unit of the currency (e.g., dollars for USD). - `interestRate` number, required — The interest rate on the loan as a floating point number. For example, 0.05 for 5%. - `interestRateType` 'FIXED' | 'VARIABLE', required — The type of interest rate on the loan. - object - `locAccount` object, required — A line-of-credit account. For example, a credit card or home equity line of credit. - `accountId` string, required — Long-term persistent identity of the account, though not an account number. - `accountNumberDisplay` string — A masked version of the account number, which includes the last 4 digits in plain text. - `productName` string, required — Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum". - `nickname` string — A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection. - `status` 'CLOSED' | 'DELINQUENT' | 'NEGATIVECURRENTBALANCE' | 'OPEN' | 'PAID' | 'PENDINGCLOSE' | 'PENDINGOPEN' | 'RESTRICTED', required - `currency` object, required - `currencyCode` string, required — The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars. - `accountType` 'LINEOFCREDIT' | 'CHARGE' | 'CREDITCARD' | 'HOMELINEOFCREDIT', required - `creditLine` number — The total credit line available on the account in the standard unit of the currency (e.g., dollars for USD). - `availableCredit` number, required — The currently available credit on the account in the standard unit of the currency (e.g., dollars for USD). - `nextPaymentAmount` number — The amount of the next payment due on the account in the standard unit of the currency (e.g., dollars for USD). - `nextPaymentDate` string — The date the next payment is due. - `principalBalance` number — The principal balance on the account in the standard unit of the currency (e.g., dollars for USD). - `currentBalance` number, required — The current balance on the account in the standard unit of the currency (e.g., dollars for USD). This includes any outstanding charges, fees, and interest. - `minimumPaymentAmount` number — The minimum payment due on the account in the standard unit of the currency (e.g., dollars for USD). - `lastPaymentAmount` number — The amount of the last payment made on the account in the standard unit of the currency (e.g., dollars for USD). - `lastPaymentDate` string — The date the last payment was made. - `pastDueAmount` number — The amount past due on the account in the standard unit of the currency (e.g., dollars for USD). - `lastStmtBalance` number — The balance on the account as of the last statement date in the standard unit of the currency (e.g., dollars for USD). - `lastStmtDate` string — The date of the last statement. - `purchasesApr` number — The annual percentage rate (APR) for purchases on the account. - `advancesApr` number — The annual percentage rate (APR) for cash advances on the account. - object - `investmentAccount` object, required — An investment account. For example, a 401K or IRA. - `accountId` string, required — Long-term persistent identity of the account, though not an account number. - `accountNumberDisplay` string — A masked version of the account number, which includes the last 4 digits in plain text. - `productName` string, required — Marketed product name for this account. You can use this in UIs to assist in account selection. For example, "Slash Platinum". - `nickname` string — A nickname or label for the account. This will be unique to the account, even if the user has multiple accounts with the same product name. You can use this in UIs to assist in account selection. - `status` 'CLOSED' | 'DELINQUENT' | 'NEGATIVECURRENTBALANCE' | 'OPEN' | 'PAID' | 'PENDINGCLOSE' | 'PENDINGOPEN' | 'RESTRICTED', required - `currency` object, required - `currencyCode` string, required — The ISO 4217 currency code for the currency that the account is denominated in. For example, "USD" for US Dollars. - `accountType` '401A' | '401K' | '403B' | '529' | 'BROKERAGEPRODUCT' | 'COVERDELL' | 'DIGITALASSET' | 'DEFINEDBENEFIT' | 'ESOP' | 'GUARDIAN' | 'INSTITUTIONALTRUST' | 'IRA' | 'KEOGH' | 'NONQUALIFIEDPLAN' | 'OTHERINVESTMENT' | 'ROLLOVER' | 'ROTH' | 'SARSEP' | 'TAXABLE' | 'TDA' | 'TRUST' | 'TERM' | 'UGMA' | 'UTMA', required - `availableCashBalance` number, required — The amount of cash available in the account across all sub-accounts, including sweep funds, in the standard unit of the currency (e.g., dollars for USD). - `balanceAsOf` string — The date and time the balance was last updated. - `currentValue` number, required — The total current value of all investments in the standard unit of the currency (e.g., dollars for USD). - `holdings` object[] — The holdings in the account. - `securityId` string — The unique identifier of the security. Either securityId and securityIdType or symbol will be provided. - `securityIdType` 'CINS' | 'CMC' | 'CME' | 'CUSIP' | 'ISIN' | 'ITSA' | 'NASDAQ' | 'SEDOL' | 'SICC' | 'VALOR' | 'WKN' — The type of the security identifier. - `holdingName` string — The name of the security. - `holdingType` 'ANNUITY' | 'BOND' | 'CD' | 'DIGITALASSET' | 'MUTUALFUND' | 'OPTION' | 'OTHER' | 'STOCK' — The type of the holding. - `holdingSubType` 'CASH' | 'MONEYMARKET' - `symbol` string — The symbol of the security. Either securityId and securityIdType or symbol will be provided. - `purchasedPrice` number — The price at which the security was purchased in the standard unit of the currency (e.g., dollars for USD). - `currentUnitPrice` number — The current unit price of the security in the standard unit of the currency (e.g., dollars for USD). - `currentUnitPriceDate` string — The date and time the current unit price was last updated. - `units` number — The number of units of the security held. - `marketValue` number, required — The market value of the holding in the standard unit of the currency (e.g., dollars for USD). - `faceValue` number — The face value of the holding in the standard unit of the currency (e.g., dollars for USD). - `cashAccount` boolean, required — If true, indicates that this holding is used to maintain proceeds from sales, dividends, and other cash postings to the investment account. - `currency` object - `currencyCode` string, required — The ISO 4217 currency code. - `fiAttributes` object[] - `name` string, required - `value` string, required ## Other responses - `401` — Unauthorized - `403` — Forbidden - `429` — TooManyRequests - `500` — Internal Error --- [API](https://skmtc.net/slashfi/apis/slash-public-api.md) · [All operations](https://skmtc.net/slashfi/apis/slash-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slashfi/slash-public-api/revisions/773c90f079c5/schema)