v1.6.0
See below for our latest API changes. This minor version upgrade brings improved input validation, additional account and depositor flexibility, and cleanup of deprecated fields and endpoints.
Updated Endpoints
-
DELETE /v1/accounts/{account_id}(Close Account)- Accounts with a non-zero balance are now automatically liquidated before closing. It is no longer necessary to manually zero out the balance before calling this endpoint.
-
POST /v1/accounts(Create Account)signer_primaryis now optionalinterest_rateis now optional with explicit validation (0 ≤ rate < 1)account_typenow accepts theAccountTypeenum (MMDA,DDA)- Added
is_reciprocation_prioritized(boolean, defaultfalse) — prioritize this account for reciprocation - Added
program_tags(string array) — tag accounts with program identifiers
-
PATCH /v1/accounts/{account_id}(Update Account)depositor_idsis now optional — you no longer need to include it in every update- Added
is_reciprocation_prioritized(boolean, optional) - Added
program_tags(string array, optional) - Added
account_type(AccountTypeenum, optional) - Added
institution_alternative_id(string, optional, deprecated)
-
POST /v1/depositors(Create Depositor)internal_depositor_idhas been replaced byinstitution_depositor_id, which was introduced in v1.5.1
-
Input validation improvements —
maxLengthconstraints have been added to string fields acrossCreateAccountRequest,CreateDepositorRequest,CreateTransactionRequest,UpdateTransactionRequest,AddressData, andPhoneNumberData.EmailData.email_addressnow validates email format, andAddressData.country_coderequires a two-character ISO 3166-1 alpha-2 code. Notable limits:account_title(128),signer_primary/signer_secondary(64),beneficiary_tin(9),tin(64),first_name/last_name(32), transactiondescription(256).
Schema Changes
-
AccountResponsesigner_primaryis now nullable- Added
institution_alternative_id(string, nullable, deprecated) - Added
is_reciprocation_prioritized(boolean, required) institution_account_idis now marked as deprecated
-
DepositorResponsetinis now nullable and marked deprecated — plan to migrate away from reading this field from responses
Removed Endpoints
GET /v1/accounts/{account_id}/documents/monthly-statements— This previously deprecated endpoint has been removed. UseGET /v1/files/statementswithstatement_type=ACCOUNT_MONTHLY_SWEEPinstead.