Balances
https://sandbox-products.ddp.akoya.com/balances/{version}/{providerId}
Account information that includes balances and rates of bank accounts, credit cards, loans, investments, and more.
To view the response schema, select the 200 response below. Then pick an option for annuity, deposit, insurance, investment, loan, and line of credit account types.
For an example payload response, see the 200 example response below the Try it feature. The example is from a deposit account but all account types are supported by this endpoint.
Use the mode query param to receive FDX-aligned, standardized data values (Beta). For example:
https://sandbox-products.ddp.akoya.com/balances/v2/mikomo?mode=standard
mode is available in both sandbox and production.
mode is supported by a subset of providers. Log into the Data Recipient Hub and click here to view a list of all providers supporting the mode parameter.
Path Parameters
version*
stringdefault: v2Akoya major version number. Do not use minor version numbers. For instance, use v2 and not v2.2
providerId*
stringdefault: mikomoId of provider
Headers
x-akoya-interaction-type
stringOptional but recommended header to include with each data request. Allowed values are `user` or `batch`. `user` indicates a request is prompted by an end-user action. `batch` indicates the request is part of a batch process.
batch
Query Parameters
mode
stringBETA. Default is raw. Use standard for FDX-aligned, standardized data values.
raw
Responses
200
OK
Response Body
object
accounts
array of objects
An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)
Any of:
depositAccount
balanceAsOf
string
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
loanAccount
balanceAsOf
string
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
Last payment date
nextPaymentAmount
number
Amount of next payment
nextPaymentDate
string
Date of next payment
originalPrincipal
number
Original principal of loan
payOffAmount
number
Payoff amount
principalBalance
number
Principal balance of loan
locAccount
balanceAsOf
string
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
Last payment date
lastStmtBalance
number
Last Statement Balance
lastStmtDate
string
Last Statement Date
minimumPaymentAmount
number
Minimum payment amount
nextPaymentAmount
number
Amount of next payment
nextPaymentDate
string
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
investmentAccount
availableCashBalance
number
Cash balance across all sub-accounts. Should include sweep funds.
balanceAsOf
string
As-of date of balances
balanceList
array of objects
Balance List. Name value pair aggregate.
object
balanceName
string
Name of the balance.
balanceDescription
string
Description of balance.
balanceType
string
The type of an investment balance. AMOUNT or PERCENTAGE.
AMOUNTPERCENTAGEbalanceValue
number
Value of balance name.
balanceDate
string
Date as of this balance.
currency
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
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
insuranceAccount
policyCoverageAmount
number
Total amount of money the user is insured for.
policyEndDate
string
The premium end date.
policyPremium
number
The amount of the user's premium.
policyPremiumTerm
string
he payment term for the premium. MONTHLY or ANNUAL.
MONTHLYANNUALpolicyStartDate
string
The premium start date.
annuityAccount
annualIncrease
number
Percent or dollar amount of annual payment increase
annualIncreaseType
string
FIXEDPERCENTDOLLARnetPresentValue
number
Surrender or cash balance value
paymentAmount
number
Amount of the recurring payment
paymentEndDate
string
Date last payment will be made
paymentStartDate
string
Date of first payment; could be a future date
periodCertainGuarantee
string
NO PERIOD CERTAIN5-YEAR10-YEAR20-YEAR30-YEARtotalPaymentCount
number
Total number of payments that will be produced by the annuity
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
206
Partial Content. Success searching for accounts. Some errors are being returned.
Response Body
object
accounts
array of objects
An array of accounts with entity types dependent on the account type (deposit, investment, loan, line of credit, annuity or insurance)
Any of:
depositAccount
balanceAsOf
string
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
loanAccount
balanceAsOf
string
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
Last payment date
nextPaymentAmount
number
Amount of next payment
nextPaymentDate
string
Date of next payment
originalPrincipal
number
Original principal of loan
payOffAmount
number
Payoff amount
principalBalance
number
Principal balance of loan
locAccount
balanceAsOf
string
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
Last payment date
lastStmtBalance
number
Last Statement Balance
lastStmtDate
string
Last Statement Date
minimumPaymentAmount
number
Minimum payment amount
nextPaymentAmount
number
Amount of next payment
nextPaymentDate
string
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
investmentAccount
availableCashBalance
number
Cash balance across all sub-accounts. Should include sweep funds.
balanceAsOf
string
As-of date of balances
balanceList
array of objects
Balance List. Name value pair aggregate.
object
balanceName
string
Name of the balance.
balanceDescription
string
Description of balance.
balanceType
string
The type of an investment balance. AMOUNT or PERCENTAGE.
AMOUNTPERCENTAGEbalanceValue
number
Value of balance name.
balanceDate
string
Date as of this balance.
currency
object
currencyCode
string
Iso 4217 currency code.
currencyRate
number
Currency rate between original and converted currency.
originalCurrencyCode
string
Iso 4217 currency code.
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
insuranceAccount
policyCoverageAmount
number
Total amount of money the user is insured for.
policyEndDate
string
The premium end date.
policyPremium
number
The amount of the user's premium.
policyPremiumTerm
string
he payment term for the premium. MONTHLY or ANNUAL.
MONTHLYANNUALpolicyStartDate
string
The premium start date.
annuityAccount
annualIncrease
number
Percent or dollar amount of annual payment increase
annualIncreaseType
string
FIXEDPERCENTDOLLARnetPresentValue
number
Surrender or cash balance value
paymentAmount
number
Amount of the recurring payment
paymentEndDate
string
Date last payment will be made
paymentStartDate
string
Date of first payment; could be a future date
periodCertainGuarantee
string
NO PERIOD CERTAIN5-YEAR10-YEAR20-YEAR30-YEARtotalPaymentCount
number
Total number of payments that will be produced by the annuity
Headers
x-akoya-interaction-idstring
Akoya supplied interaction id used for logging and error tracking
400
401 - Invalid input
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
401
602 - Customer not authorized
Response Body
code
integer
message
string
404
701 - Tax Lots not found. The `holdingId` may be wrong.
Response Body
code
integer
message
string
406
1203 - Content Type not Supported
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
429
1207 - Too many requests
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
500
500 - Internal server error
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
501
1106 - Version not supported or not implemented
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
503
503 - System is down for maintenance
Response Body
object
code
integer
Long term persistent identifier which can be used to trace error condition back to log information
message
string
End user displayable information which might help the customer diagnose an error
Try it
Authorization
const options = {
"method": "GET",
"headers": {
"x-akoya-interaction-type": "batch"
}
}};
fetch('https://sandbox-products.ddp.akoya.com/balances/v2/mikomo?mode=raw', options)
.then(response => response.json())
.catch(err => console.error(err));