Skip to navigation
API ReferenceAccounts

List Account Accrued Interest

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Query parameters

id_typeenum or nullOptional
Type of the account id. Must be 'institution' or 'None'.
Allowed values:
start_datestring or nullOptionalformat: "date"

Return accruals on or after this date (YYYY-MM-DD). Pass with end_date; the range can span at most 366 days. If both are omitted, returns the current month (Eastern Time).

end_datestring or nullOptionalformat: "date"

Return accruals on or before this date (YYYY-MM-DD). Pass with start_date; the range can span at most 366 days. If both are omitted, returns the current month (Eastern Time).

Response

Successful Response
account_idstring
ModernFi account ID.
accrualslist of objects
Daily accruals, newest first.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error