Web APIFIX API
API Reference
API StatusLogin

Create Deposit

post
https://bo-api.drivewealth.io/back-office/funding/deposits

Creates a Deposit.

Body Params
string
required

The user's unique account number, that is human readable.

number
required

The amount that will be deposited into the user's account.

string
enum
required

The name of the currency in abbreviation form.

Show Details
USDU.S. Dollar.
Allowed:
string
enum
required

The method/form in which the funds will be arriving to the user's account.

Show Details
ACHArriving via ACH transfer.
BULK_FUNDINGArriving via bulk funding.
CASH_PROMOTIONA promotional cash credit.
CASH_TRANSFERArriving via cash transfer.
Allowed:
string

The unique DriveWealth identifier that identifies each linked bank account.

string

A way to store a message/comment on the this object.

string
enum

The type of contribution deposit for retirement accounts.

Note: Trump accounts have their own enums. Click here for more details.

Show Details
CURRENT_YEARA contribution for the current tax year.
PRIOR_YEARA contribution for the prior tax year.
POSTPONED_CONTRIBUTIONA postponed contribution.
REPAYMENTA repayment contribution.
SEC_128_EMPLOYERAn employer contribution (Trump account).
OTHER_SOURCEAn individual contribution (Trump account).
QUALIFIED_ROLLOVERA trustee-to-trustee transfer of the entire balance from another Trump account.
PILOT_PROGRAMA contribution under the U.S. Treasury pilot program (Trump account).
QUALIFIED_GENERALA grant from a government, tribe, or 501(c)(3) organization (Trump account).
PROMOTIONAL_EARNINGA promotional earning contribution.
string
enum

The sub type to be used for POSTPONED_CONTRIBUTION, REPAYMENT, or PROMOTIONAL_EARNING contributions for retirement accounts. Click here for more details.

Show Details
SCThe self-certification procedure for a late rollover contribution.
POA rollover of a qualified plan loan offset.
FDDue to a federally designated disaster.
EOCombat zone or hazardous duty area, declared by Executive Order.
PLCombat zone or hazardous duty area, not declared by Executive Order.
QRRepayment of a qualified reservist distribution.
DDRepayment of a qualified disaster recovery distribution.
BARepayment of a qualified birth or adoption distribution.
EPRepayment of an emergency personal expense distribution.
DARepayment of a domestic abuse victim distribution.
TIRepayment of a terminally ill individual distribution.
SUA signup bonus (account opening bonus).
FRA fee reimbursement (e.g. prior broker exit fee).
string
enum

The recurring deposit frequency; only available for ACH deposits. Note: For retirement accounts, recurring schedules are restricted to CURRENT_YEAR contributions only.

Show Details
BIWEEKLYEvery two weeks.
DAILYEvery day.
MONTHLYOnce a month.
MONTHLY_FIRSTOnce a month, on the first business day.
MONTHLY_MIDDLEOnce a month, around the middle of the month.
QUARTERLYOnce every three months.
Allowed:
string

The start date of the recurring deposit. The date should be in the future and within 90 days.

string

A settlement profile identifier that links to a specific bank account for fund settlement.

originatorBankDetails
object
metadata
object

The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes.

Headers
string

A unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 months ago

Did this page help you?