Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Deposits

Create Deposit

Creates a Deposit.

post/funding/deposits

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

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

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

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

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'

The sub type to be used for POSTPONED_CONTRIBUTION or REPAYMENT 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.

metadataobject

The metadata object allows for creating a maximum of 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

Example request

{
  "accountNo": "DWBG000052",
  "amount": 250.25,
  "currency": "USD",
  "type": "ACH",
  "bankAccountID": "bank_a4656e60-321e-425b-aa0d-a2e75c38885f",
  "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": "110000000",
    "bankName": "Bank of America",
    "bankAddress": "222 Broadway, New York City, NY, 10038",
    "accountHolderName": "Justin Smith",
    "accountHolderAddress": "15 Exchange Place, Jersey City, NJ, 07302",
    "accountHolderCountry": "USA",
    "bankCountry": "USA"
  },
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Creating a User's Account Deposit was successful.

idstring

A unique identifier for the Deposit.

accountNostring

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.

status'STARTED' | 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'APPROVED' | 'REJECTED' | 'ON_HOLD' | 'PROCESSING' | 'RETURNED' | '-'

The current status of the user's deposit.

createdstring
accountIDstring

The user's unique account identifier.

userIDstring

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

transactionCode'JOURNAL' | 'FEE_ACH' | 'DISBURSEMENT_ACH_SVB'
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'

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'

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

batchboolean

Example response

{
  "id": "-DMIQY",
  "accountNo": "DWBG000052",
  "category": "DEPOSIT",
  "currency": "USD",
  "amount": 250.25,
  "status": "PENDING",
  "source": {
    "id": "ACH",
    "brand": "ACH",
    "meta_info": "Hey! Welcome to DriveWealth Developer Docs!"
  },
  "created": "2022-12-11T22:28:21.810Z",
  "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "transactionCode": "JOURNAL",
  "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
  "iraContribution": "POSTPONED_CONTRIBUTION",
  "iraContributionSubType": "SC",
  "batch": true,
  "recurring": {
    "id": "recurring_98be6652-6361-4d4c-905b-06e9ec38d060",
    "nextDeposit": "2019-01-15",
    "frequency": "MONTHLY_FIRST"
  }
}