Skip to navigation

v1.6.7

Happy Thanksgiving from the ModernFi team! See below for our latest API changes. This release adds institution opt-outs, so depositors can see and manage the institutions their funds are excluded from, and accrued interest and APY on every account, with a new daily accrued interest endpoint. It also adds the time an account’s balance last changed and a Get Institution endpoint that returns your sweep account product name. We recommend reviewing this page closely before beginning development or upgrading to a new API version.

New Endpoints

Institution Opt-Outs — A depositor can exclude specific banks or credit unions from receiving their account’s funds. These endpoints list an account’s exclusions, add and remove them, and search the FDIC/NCUA catalog for institutions to exclude. Each institution is identified by its federal_id: F plus its FDIC certificate number for a bank, or N plus its NCUA charter number for a credit union.

  • GET /digital-banking/v1/accounts/{account_id}/institution-opt-outs (List Account Institution Opt Outs)

    • Returns opt_outs (InstitutionOptOutDetail array), the exclusions of every owner of the account combined and ordered by federal_id, and is_editable (boolean). An account with no exclusions returns an empty list.
    • is_editable is true when your institution allows self-service exclusions and the account has a single owner. When it is false, show the exclusions read-only.
    • Accepts the id_type query parameter, so you can look up the account by your own account number. Works on open accounts.
  • POST /digital-banking/v1/accounts/{account_id}/institution-opt-outs (Add Account Institution Opt Out)

    • Excludes one institution and returns the account’s full exclusion list in the same shape as the list call.
    • Request body: federal_id (string, required, max 8, F or N followed by up to 7 digits) and submitted_by (string, required, email, max 128), the user making the change. A bare certificate number is read as your own institution type.
    • Only institutions of your own type can be added. A credit union can also exclude the banks where ModernFi places credit union funds. Any other institution returns 400. Adding an institution that is already excluded changes nothing, so the call is safe to retry.
    • Returns 403 when is_editable is false: your institution does not allow self-service exclusions, or the account has more than one owner. Requires write access.
  • DELETE /digital-banking/v1/accounts/{account_id}/institution-opt-outs/{federal_id} (Remove Account Institution Opt Out)

    • Removes one institution of either type, given as a federal_id from the list call, and returns the account’s full exclusion list.
    • Takes a JSON request body with submitted_by (string, required, email, max 128). Make sure your HTTP client sends a body with this DELETE.
    • Removing an institution that is not excluded changes nothing. Returns 403 under the same conditions as the add call. Requires write access.
  • GET /digital-banking/v1/institution-opt-out-catalog (List Institution Opt Out Catalog)

    • Searches the FDIC/NCUA catalog for institutions of your own type, ordered by name, and returns them as institutions (OptOutCatalogInstitution array). For a credit union, the results also include those banks.
    • Query parameters: search (string, optional, max 256), a partial match on name, certificate number, or federal ID, or an exact ABA routing number; limit (integer, optional, 1–1000, default 100); and offset (integer, optional, default 0).
    • Send a result’s federal_id to the add call to exclude that institution.

Accrued Interest — The daily interest an account earns, the same figures the depositor portal shows.

  • GET /digital-banking/v1/accounts/{account_id}/accrued-interest (List Account Accrued Interest)
    • Returns accruals (DailyAccruedInterestResponse array), one row per day, newest first: accrual_date, balance, rate_nominal, rate_apy, amount, and month_to_date_amount.
    • Query parameters: start_date and end_date (date, optional). The range is inclusive and can span at most 366 days. Omit both to get the current month in Eastern Time. Passing only one, a start_date after end_date, or a longer range returns 400.
    • month_to_date_amount is the running total from the first of the month, even when start_date falls mid-month, and it never goes below zero.
    • Accepts the id_type query parameter, so you can look up the account by your own account number.

Institution — Settings of the institution your API credentials belong to.

  • GET /digital-banking/v1/institution (Get Institution)
    • Returns sweep_account_product_name (string, nullable): the name your admins gave the ModernFi sweep account product in the admin portal. It is null when no name is set or the name is blank, so show your own default name instead.
    • Takes no institution ID. The institution always comes from your API credentials.

Schema Changes

  • AccountResponse
    • Added interest_rate_apy (decimal string, required): the annual percentage yield of interest_rate under monthly compounding, to 9 decimal places. You can show depositors the yield they earn without computing it yourself.
    • Added mtd_accrued_interest (decimal string, required): the interest accrued this calendar month, in Eastern Time. Use the new accrued interest endpoint for the daily breakdown.
    • Added total_balance_updated_at (datetime, nullable, optional): when total_balance last changed, which is the time the most recent transaction counted in it posted. It is null when no transaction has posted to the account. Pending transactions and postings dated in the future do not move it. Use it to label a balance with the time it was last updated.
    • These fields appear on every endpoint that returns an account, including List Accounts and Get Account.

New schemas: AccountInstitutionOptOutsResponse, InstitutionOptOutDetail, AddAccountInstitutionOptOutRequest, RemoveAccountInstitutionOptOutRequest, OptOutCatalogResponse, OptOutCatalogInstitution, AccruedInterestResponse, DailyAccruedInterestResponse, InstitutionSettingsResponse.