Create Account

idempotency-keystring required

Request body

signer_primarystring nullable

signer_primary_tinstring nullable

account_titlestring required

account_type'MMDA' | 'DDA' required

depositor_idsstring[] required

program_tagsstring[]

is_apyboolean

Indicates if the interest rate is an Annual Percentage Yield (APY). If ommitted or false, the rate is considered a nominal interest rate.

interest_ratenumber nullable

Interest rate must be between 0 and 1 (e.g., 0.04 for 4%).

signer_secondarystring nullable

beneficiary_namestring nullable

beneficiary_tinstring nullable

institution_account_idstring nullable

institution_sweep_account_idstring nullable

institution_return_account_idstring nullable

institution_branch_idstring nullable

institution_cost_center_idstring nullable

cost_center_idstring uuid nullable

account_agreement_file_datastring nullable

Base64 encoded PDF file data (max 25MB)

notesstring nullable

Notes for the account

pricing_group_idstring uuid nullable

Pricing group ID associated with the account

is_reciprocation_prioritizedboolean

Whether this account should be prioritized for reciprocation.

is_receiving_printed_statementsboolean

Whether this account should receive printed statements.

account_officerstring nullable

Account officer assigned to this account (free-text)

is_non_interest_bearingboolean

Whether this account is non-interest-bearing. If true, no interest rates, tiers, or pricing groups can be assigned.

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

Response

Successful Response

idstring required

institution_idstring required

signer_primarystring nullable required

signer_primary_tin_last4string nullable

account_titlestring required

interest_ratestring required

insurance_limitstring required

account_type'MMDA' | 'DDA' required

created_atstring required

is_joint_accountboolean required

total_balancestring required

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

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