DRdrivewealth
Deposits

Create Deposit

Creates a Deposit.

post/funding/deposits

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/funding/deposits
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring
Example:a1b2c3d4-5e6f-7g8h-9i0j-1k2l3m4n5o6

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.

Request body

accountNostring required

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

amountnumber required

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

currency'USD' required

The name of the currency in abbreviation form.

type'ACH' | 'BULK_FUNDING' | 'CASH_PROMOTION' | 'CASH_TRANSFER' required

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

bankAccountIDstring

The unique DriveWealth identifier that identifies each linked bank account.

notestring

sensitive A way to store a message/comment on the this object. Do not put personal or account data in this field.

iraContribution'CURRENT_YEAR' | 'PRIOR_YEAR' | 'POSTPONED_CONTRIBUTION' | 'REPAYMENT' | 'SEC_128_EMPLOYER' | 'OTHER_SOURCE' | 'QUALIFIED_ROLLOVER' | 'PILOT_PROGRAM' | 'QUALIFIED_GENERAL' | 'PROMOTIONAL_EARNING' | 'CORRECTIVE_DEPOSIT'

The type of contribution deposit for retirement accounts.

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

iraContributionSubType'SC' | 'PO' | 'FD' | 'EO' | 'PL' | 'QR' | 'DD' | 'BA' | 'EP' | 'DA' | 'TI' | 'SU' | 'FR' | 'RF' | 'RB' | 'RL' | 'AT' | 'AF' | 'AD'

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

recurringFrequency'BIWEEKLY' | 'DAILY' | 'MONTHLY' | 'MONTHLY_FIRST' | 'MONTHLY_MIDDLE' | 'QUARTERLY'

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

startDatestring

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

settlementProfileIDstring

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

metadataMetadataMoneyMovement

sensitive The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

Example request

{
  "accountNo": "FFFF000005",
  "amount": 250.25,
  "currency": "USD",
  "type": "ACH",
  "bankAccountID": "bank_123e4567-e89b-12d3-a456-00000000004a",
  "note": "Hey! Welcome to DriveWealth Developer Docs!",
  "iraContribution": "POSTPONED_CONTRIBUTION",
  "iraContributionSubType": "SC",
  "recurringFrequency": "MONTHLY_FIRST",
  "startDate": "2017-09-18",
  "settlementProfileID": "settlement-profile-bank-account-1",
  "originatorBankDetails": {
    "bankAccountNumber": "7442393174",
    "bankRoutingNumber": "123456789",
    "bankName": "Bank of America",
    "bankAddress": "222 Broadway, New York City, NY, 10038",
    "accountHolderName": "John Doe",
    "accountHolderAddress": "123 Main Street, New York, NY, 10001",
    "accountHolderCountry": "USA",
    "bankCountry": "USA"
  },
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Creating a User's Account Deposit was successful.

idstring

A unique identifier for the Deposit.

accountNostring

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

categorystring
currency'USD'

The name of the currency in abbreviation form.

amountnumber

The amount of cash that is being deposited into the user's account.

createdstring
accountIDstring

sensitive The user's unique account identifier.

userIDstring

sensitive A unique identifier created for each User on DriveWealth's platform.

transactionCode'DISBURSEMENT_ACH_BMO' | 'DISBURSEMENT_ACH_JPM' | 'DISBURSEMENT_ACH_MT' | 'DISBURSEMENT_ACH_RETURN_MT' | 'DISBURSEMENT_BULK_FUNDING' | 'DISBURSEMENT_CASH_PROMOTION' | 'DISBURSEMENT_CASH_TRANSFER' | 'DISBURSEMENT_WIRE_JPM' | 'DISBURSEMENT_WIRE_MT' | 'DISBURSEMENT_WIRE_RETURN_JPM' | 'DISBURSEMENT_WIRE_RETURN_MT' | 'FEE_AUM' | 'JOURNAL' | 'RECEIPT_ACH_BMO' | 'RECEIPT_ACH_JPM' | 'RECEIPT_ACH_MT' | 'RECEIPT_ACH_RETURN_MT' | 'RECEIPT_BULK_FUNDING' | 'RECEIPT_CASH_PROMOTION' | 'RECEIPT_CASH_TRANSFER' | 'RECEIPT_WIRE_JPM' | 'RETIREMENT_CONTRIBUTION_ACH_API' | 'RETIREMENT_CONTRIBUTION_ACH_API_RETURN' | 'RETIREMENT_CONTRIBUTION_ACH_VRN' | 'RETIREMENT_CONTRIBUTION_BULK_FUNDING' | 'RETIREMENT_CONTRIBUTION_CASH_TRANSFER' | 'RETIREMENT_CONTRIBUTION_WIRE_VRN' | 'RETIREMENT_DISTRIBUTION_ACH_API' | 'RETIREMENT_DISTRIBUTION_ACH_API_RETURN' | 'RETIREMENT_DISTRIBUTION_WIRE_MANUAL'

The transaction code identifying how/why the funds were posted. Valid values depend on the transaction types configured for the partner. May be absent if no transaction code was assigned.

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

iraContribution'CURRENT_YEAR' | 'PRIOR_YEAR' | 'POSTPONED_CONTRIBUTION' | 'REPAYMENT' | 'SEC_128_EMPLOYER' | 'OTHER_SOURCE' | 'QUALIFIED_ROLLOVER' | 'PILOT_PROGRAM' | 'QUALIFIED_GENERAL' | 'PROMOTIONAL_EARNING' | 'CORRECTIVE_DEPOSIT'

The type of contribution deposit for retirement accounts.

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

iraContributionSubType'SC' | 'PO' | 'FD' | 'EO' | 'PL' | 'QR' | 'DD' | 'BA' | 'EP' | 'DA' | 'TI' | 'SU' | 'FR' | 'RF' | 'RB' | 'RL' | 'AT' | 'AF' | 'AD'

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

reportableTaxYearinteger nullable

The tax year the IRA contribution deposit is reportable for, derived from the transaction date and iraContribution type. null for deposits that are not retirement-account contributions.

batchboolean

Example response

{
  "id": "YYYY009000-1234567890136-1A2B3",
  "accountNo": "FFFF000005",
  "category": "DEPOSIT",
  "currency": "USD",
  "amount": 250.25,
  "status": {
    "id": 1,
    "message": "PENDING",
    "updated": "2022-12-11T22:28:21.810Z"
  },
  "source": {
    "id": "ACH",
    "brand": "ACH",
    "meta_info": "Hey! Welcome to DriveWealth Developer Docs!"
  },
  "created": "2022-12-11T22:28:21.810Z",
  "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
  "userID": "123e4567-e89b-12d3-a456-000000000004",
  "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
  "iraContribution": "POSTPONED_CONTRIBUTION",
  "iraContributionSubType": "SC",
  "reportableTaxYear": 2026,
  "batch": true,
  "recurring": {
    "id": "recurring_123e4567-e89b-12d3-a456-00000000004d",
    "nextDeposit": "2019-01-15",
    "frequency": "MONTHLY_FIRST"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.