Balances
Balances and rates of bank accounts, credit cards, loans, investments, and more.
The Akoya Balances product combines basic end-user account information with the latest, actionable financial account data including: available balance, payment amounts, due dates, credit card rewards details, limits, due dates, year-to-date interest, and more.
The balances endpoint returns all data available in the Account info product plus data such as current balance, payment dates, and other data (listed below). To use this product, you must have the end-user’s consent and their associated ID token for permissioned data.
Results for balances are returned in JSON in FDX format. Balances include a common grouping of data and may contain additional data elements for annuity, deposit, insurance, investment, line of credit, or loan account categories.
Endpoint: /balances
API documentation: https://docs.akoya.com/v2/reference/get-balances
Example response
{
"depositAccount": {
"accountId": "g833202fb0866d0ad83472c429",
"accountType": "CHECKING",
"accountNumberDisplay": "xxxxxxxx0071",
"currency": {
"currencyCode": "USD"
},
"description": "Checking Plus",
"fiAttributes": [
{
"name": "accountOpenedDate",
"value": "2020-04-23"
},
{
"name": "interestPaidLastYear",
"value": "3.20"
}
],
"nickname": "Nickname Checking Plus 0071",
"productName": "Checking Plus",
"status": "OPEN",
"lineOfBusiness": "Personal",
"balanceType": "ASSET",
"interestRate": 0.0125,
"interestRateType": "FIXED",
"interestRateAsOf": "2022-03-24T14:15:22Z",
"lastActivityDate": "2022-03-24T14:15:22Z",
"currentBalance": 106717.06,
"availableBalance": 106717.06,
"balanceAsOf": "2022-03-24T14:15:22Z"
}
}
Supported data elements
Note
Balances product responses vary by account category.
All account categories
include:
| Name | Required | Description |
|---|---|---|
| account info | true | Includes account info data elements |
Deposit accounts
may also include:
| Name | Type | Description |
|---|---|---|
| balanceAsOf | string(date-time) | As-of date of balances |
| openingDayBalance | number | Day's opening fund balance |
| availableBalance | number | Balance of funds available for use |
| interestYtd | number | YTD Interest |
| currentBalance | number | Balance of funds in account |
Loan accounts
may also include:
| Name | Type | Description |
|---|---|---|
| balanceAsOf | string(date-time) | As-of date of balances |
| escrowBalance | number | Escrow balance of loan |
| interestPaidYearToDate | number | Interest paid year to date |
| lastPaymentAmount | number | Last payment amount |
| lastPaymentDate | string(date-time) | Last payment date |
| nextPaymentAmount | number | Amount of next payment |
| nextPaymentDate | string(date-time) | Date of next payment |
| originalPrincipal | number | Original principal of loan |
| payOffAmount | number | Payoff amount |
| principalBalance | number | Principal balance of loan |
Line of credit accounts
may also include:
| Name | Type | Description |
|---|---|---|
| balanceAsOf | string(date-time) | As-of date of balances |
| advancesApr | number | Advances APR |
| availableCash | number | Available cash |
| availableCredit | number | Available credit |
| cashAdvanceLimit | number | Cash advance limit |
| creditLine | number | Credit limit |
| currentBalance | number | Current balance LOC |
| currentRewardsBalance | number | Current rewards balance |
| financeCharges | number | Finance charges |
| lastPaymentAmount | number | Last payment amount |
| lastPaymentDate | string(date-time) | Last payment date |
| lastStmtBalance | number | Last Statement Balance |
| lastStmtDate | string(date-time) | Last Statement Date |
| minimumPaymentAmount | number | Minimum payment amount |
| nextPaymentAmount | number | Amount of next payment |
| nextPaymentDate | string(date-time) | Due date of next payment |
| pastDueAmount | number | Past Due Amount |
| pointsAccrued | number | Points accrued |
| principalBalance | number | Principal balance |
| pointsRedeemed | number | Points redeemed |
| purchasesApr | number | Purchases APR |
Investment accounts
may also include:
| Name | Type | Description |
|---|---|---|
| availableCashBalance | number | Cash balance across all sub-accounts. Should include sweep funds. |
| balanceAsOf | string(date-time) | As-of date of balances |
| balanceList | array | Array of balanceList objects. |
| currentValue | number | Total current value of all investments |
| dailyChange | number | Daily change |
| marginBalance | number | Margin balance |
| percentageChange | number | Percentage change |
| rolloverAmount | number | Rollover amount |
| shortBalance | number | Short balance |
balanceList
| Name | Type | Description |
|---|---|---|
| balanceName | string | Name of the balance. |
| balanceDescription | string | Description of balance. |
| balanceType | string | The type of an investment balance. AMOUNT or PERCENTAGE. |
| balanceValue | number | Value of balance name. |
| balanceDate | string(date-time) | Date as of this balance. |
| currency | currency object | currency object which may include currencyRate, currencyCode, and originalCurrencyCode |
Insurance accounts
may also include:
| Name | Type | Description |
|---|---|---|
| policyCoverageAmount | number | Total amount of money the user is insured for. |
| policyEndDate | string(date-time) | The premium end date. |
| policyPremium | number | The amount of the user's premium. |
| policyPremiumTerm | string | The payment term for the premium. MONTHLY or ANNUAL. |
| policyStartDate | string(date-time) | The premium start date. |
Annuity accounts
may also include:
All of the below are deprecated in FDX 5 and will be removed in FDX 6.
| Name | Type | Description |
|---|---|---|
| annualIncrease | number | Percent or dollar amount of annual payment increase |
| annualIncreaseType | string | FIXED, PERCENT, DOLLAR. Deprecated, will be removed in FDX 6.0. |
| netPresentValue | number | Surrender or cash balance value |
| paymentAmount | number | Amount of the recurring payment |
| paymentEndDate | string(date-time) | Date last payment will be made |
| paymentStartDate | string(date-time) | Date of first payment; could be a future date |
| periodCertainGuarantee | string | NONE, 5-YEAR, 10-YEAR, 20-YEAR, 30-YEAR. |
| totalPaymentCount | number | Total number of payments that will be produced by the annuity |
Updated over 1 year ago