APIs updated: Accounts, Contribution Limits, Deposits, Payments, Settlements, Withdrawals

Breaking changes in this release: None. All changes are additive; no existing field, value, or behavior is removed or renamed. See what counts as breaking.

Deprecations in this release: margin.bodDTBP, margin.rtExcessEquity

Note on enum values: Treat enum values as an open set so unrecognized values are handled gracefully.

The DriveWealth platform is periodically updated with new API features, additional
documentation, and fixes for known issues. These release notes document these updates
with new notes at every release of an updated API or new API.

Subscribe to the DriveWealth Changelog RSS feed. Click below to copy the feed link directly to your clipboard.

New

• Accounts · Non-breaking — Added field margin.maintenanceExcess to responses.

  • Affected endpoints: GET /accounts/{accountID}/summary, GET /accounts/{accountID}/summary/margin

• Settlements · Non-breaking — Added fields amounts.purchasesOptions and amounts.salesOptions to responses.

  • Affected endpoints: GET /funding/reconciliations/{reconciliationID}, PATCH /funding/reconciliations/{reconciliationID}, PATCH /funding/reconciliations/{reconciliationID}/attest

Now generally available

• Contribution Limits · Non-breaking — Enum value CORRECTIVE_DEPOSIT of contributionType is now generally available.

  • Affected endpoints: GET /users/USERID/annual-contribution-tally

• Deposits, Payments · Non-breaking — Enum values AD, AF, AT, RB, RF, and RL of iraContributionSubType and enum value CORRECTIVE_DEPOSIT of iraContribution are now generally available.

  • Affected endpoints: GET /accounts/{accountID}/funding/payments, POST /funding/deposits, GET /funding/deposits/{depositID}, PATCH /funding/deposits/{depositID}/achSettlement, GET /funding/payments, GET /users/USERID/funding/payments

Deprecated

• Accounts · Non-breaking — margin.bodDTBP is deprecated. Retirement date: TBD.

  • Affected endpoints: GET /accounts/{accountID}/summary, GET /accounts/{accountID}/summary/margin

• Accounts · Non-breaking — margin.rtExcessEquity is deprecated. Use maintenanceExcess instead. Retirement date: TBD.

  • Affected endpoints: GET /accounts/{accountID}/summary, GET /accounts/{accountID}/summary/margin

Documentation

• Accounts · Non-breaking — Updated the descriptions of equityRequired, accruedInterest, patternDayTrader, restricted, daySMA, effectiveSMA, noBuyingPowerReason, and marginCall.

  • Affected endpoints: GET /accounts/{accountID}/summary, GET /accounts/{accountID}/summary/margin

• Withdrawals · Non-breaking — Updated the description of amount.

  • Affected endpoints: POST /funding/redemptions