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

curl --location --request GET 'https://sandbox-products.ddp.akoya.com/balances/v2/{providerId}/' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Authorization: Bearer {id_token}

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:

NameRequiredDescription
account infotrueIncludes account info data elements

Deposit accounts

may also include:

NameTypeRequiredDescription
balanceAsOfstring(date-time)trueAs-of date of balances
openingDayBalancenumberfalseDay's opening fund balance
availableBalancenumbertrueBalance of funds available for use
interestYtdnumberfalseYTD Interest
currentBalancenumbertrueBalance of funds in account

Loan accounts

may also include:

NameTypeRequiredDescription
balanceAsOfstring(date-time)trueAs-of date of balances
escrowBalancenumberfalseEscrow balance of loan
interestPaidYearToDatenumbertrueInterest paid year to date
lastPaymentAmountnumberfalseLast payment amount
lastPaymentDatestring(date-time)falseLast payment date
nextPaymentAmountnumbertrueAmount of next payment
nextPaymentDatestring(date-time)trueDate of next payment
originalPrincipalnumbertrueOriginal principal of loan
payOffAmountnumbertruePayoff amount
principalBalancenumbertruePrincipal balance of loan

Line of credit accounts

may also include:

NameTypeRequiredDescription
balanceAsOfstring(date-time)trueAs-of date of balances
advancesAprnumberfalseAdvances APR
availableCashnumberfalseAvailable cash
availableCreditnumbertrueAvailable credit
cashAdvanceLimitnumberfalseCash advance limit
creditLinenumbertrueCredit limit
currentBalancenumbertrueCurrent balance LOC
currentRewardsBalancenumbertrueCurrent rewards balance
financeChargesnumberfalseFinance charges
lastPaymentAmountnumberfalseLast payment amount
lastPaymentDatestring(date-time)falseLast payment date
lastStmtBalancenumbertrueLast Statement Balance
lastStmtDatestring(date-time)trueLast Statement Date
minimumPaymentAmountnumbertrueMinimum payment amount
nextPaymentAmountnumbertrueAmount of next payment
nextPaymentDatestring(date-time)trueDue date of next payment
pastDueAmountnumbertruePast Due Amount
pointsAccruednumberfalsePoints accrued
principalBalancenumbertruePrincipal balance
pointsRedeemednumberfalsePoints redeemed
purchasesAprnumbertruePurchases APR

Investment accounts

may also include:

NameTypeRequiredDescription
availableCashBalancenumbertrueCash balance across all sub-accounts. Should include sweep funds.
balanceAsOfstring(date-time)trueAs-of date of balances
balanceListarrayfalseArray of balanceList objects.
currentValuenumbertrueTotal current value of all investments
dailyChangenumberfalseDaily change
marginBalancenumbertrueMargin balance
percentageChangenumberfalsePercentage change
rolloverAmountnumberfalseRollover amount
shortBalancenumberfalseShort balance

balanceList

NameTypeRequiredDescription
balanceNamestringtrueName of the balance.
balanceDescriptionstringfalseDescription of balance.
balanceTypestringtrueThe type of an investment balance. AMOUNT or PERCENTAGE.
balanceValuenumbertrueValue of balance name.
balanceDatestring(date-time)trueDate as of this balance.
currencycurrency objectfalsecurrency object which may include currencyRate, currencyCode, and originalCurrencyCode

Insurance accounts

may also include:

NameTypeRequiredDescription
policyCoverageAmountnumberfalseTotal amount of money the user is insured for.
policyEndDatestring(date-time)falseThe premium end date.
policyPremiumnumberfalseThe amount of the user's premium.
policyPremiumTermstringfalseThe payment term for the premium. MONTHLY or ANNUAL.
policyStartDatestring(date-time)falseThe premium start date.

Annuity accounts

may also include:

All of the below are deprecated in FDX 5 and will be removed in FDX 6.

NameTypeRequiredDescription
NameTypeRequiredDescription
annualIncreasenumberfalsePercent or dollar amount of annual payment increase
annualIncreaseTypestringfalseFIXED, PERCENT, DOLLAR. Deprecated, will be removed in FDX 6.0.
netPresentValuenumberfalseSurrender or cash balance value
paymentAmountnumbertrueAmount of the recurring payment
paymentEndDatestring(date-time)trueDate last payment will be made
paymentStartDatestring(date-time)trueDate of first payment; could be a future date
periodCertainGuaranteestringfalseNONE, 5-YEAR, 10-YEAR, 20-YEAR, 30-YEAR.
totalPaymentCountnumberfalseTotal number of payments that will be produced by the annuity