Accounts
get/digital-banking/v1/accounts

Request

Query parameters

statusesAccountStatus[] nullable

Filter accounts by status. May be specified multiple times (e.g. ?statuses=CLOSED&statuses=SCHEDULED_FOR_CLOSURE). If omitted, accounts of all statuses are returned.

institution_account_idsstring[] nullable

Return only accounts whose institution_sweep_account_id or institution_return_account_id is one of these values. Repeat the parameter for each value, up to 1000 per request. Closed accounts are included unless statuses is also supplied.

Response

Successful Response

idstring required
institution_idstring required
signer_primarystring nullable required
signer_primary_tin_last4string nullable
account_titlestring required
interest_ratestring required
interest_rate_apystring required

Annual percentage yield of interest_rate under monthly compounding (decimal-as-string, 9 decimal places).

mtd_accrued_intereststring required

Interest accrued this calendar month (Eastern Time).

insurance_limitstring required
account_type'MMDA' | 'DDA' required
created_atstring required
is_joint_accountboolean required
total_balancestring required
total_balance_updated_atstring nullable

When total_balance last changed: the time the most recent transaction counted in it posted (ISO 8601). Null when no transaction has posted to the account.

pending_balancestring required
closed_atstring nullable
signer_secondarystring nullable
beneficiary_namestring nullable
beneficiary_tinstring nullable
beneficiary_tin_last4string nullable
institution_account_idstring nullable
institution_sweep_account_idstring nullable
institution_return_account_idstring nullable
institution_branch_idstring nullable
institution_alternative_idstring nullable
cost_center_idstring nullable
cost_center_codestring nullable
managed_sweep_target_balancestring nullable
notesstring nullable
pricing_group_idstring nullable
is_reciprocation_prioritizedboolean required
is_receiving_printed_statementsboolean required
ratestring nullable
floating_spreadstring nullable
floating_spread_bpsstring nullable
rate_index_type'EFFR' | 'CU_RECEIVE_DEFAULT' | 'BANK_RECEIVE_DEFAULT' | 'EFFR_UPPER_BAND' | 'EFFR_LOWER_BAND' | 'SOFR_OVERNIGHT' | 'SOFR_1M' | 'SOFR_3M' | 'SOFR_6M' | 'SOFR_12M' | 'CMT_1M' | 'CMT_3M' | 'CMT_6M' | 'FIDELITY_FISXX' | 'FIDELITY_SPAXX' | 'FIDELITY_FCIXX' | 'WSJ_PRIME' | 'IORB'
floating_rate_percentagestring nullable
index_ratestring nullable
custom_benchmark_idstring nullable
custom_benchmark_ratestring nullable
rate_configuration'FIXED' | 'FLOATING_MARKET' | 'FLOATING_CUSTOM' | 'TIERED' | 'MIXED' required
account_officerstring nullable

Account officer assigned to this account

is_non_interest_bearingboolean

Whether this account is non-interest-bearing

custom_field_1string nullable

Custom field 1

custom_field_2string nullable

Custom field 2

custom_field_3string nullable

Custom field 3

custom_field_4string nullable

Custom field 4

is_q2_funds_transfer_enabledboolean

Whether the Q2 digital banking integration may move this account's funds. False when the institution's Q2 enrollment is not enabled or the account is exempt from integration.

Changes

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the optional property / to the response with the status