Create Deposit

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

Creates a Deposit.

Body Params

accountNo

string

required

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

amount

number

required

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

currency

string

required

The name of the currency in abbreviation form.

type

string

required

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

bankAccountID

string

The unique DriveWealth identifier that identifies each linked bank account.

note

string

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

iraContribution

string

The type of contribution deposit for retirement accounts.

recurringFrequency

string

The recurring deposit frequency.

startDate

string

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

settlementProfileID

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 5 keys (max 36 characters) and each value cannot exceed more than 128 bytes.

Response

Response body

object

string

A unique identifier for the Deposit.

accountNo

string

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

category

string

currency

string

The name of the currency in abbreviation form.

USD

amount

number

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

status

string

The current status of the user's deposit.

STARTED PENDING SUCCESSFUL FAILED OTHER APPROVED REJECTED ON_HOLD RETURNED -

source

object

string

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

ACH WIRE BULK_FUNDING CASH_PROMOTION CASH_TRANSFER

brand

string

A custom description about the type of deposit.

meta_info

string

A way to store a message/note on the deposit object.

created

string

The date and time the deposit was created for the user's account.

accountID

string

The user's unique account identifier.

userID

string

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

transactionCode

string

JOURNAL FEE_ACH DISBURSEMENT_ACH_SVB

wlpFinTranTypeID

string

A unique identifier to id different type of transactions.

batch

boolean

recurring

object

string

A unique identifier of the recurring deposit.

nextDeposit

string

The date of when the next recurring deposit will be triggered.

active

boolean

True, if the recurring deposit is active.

frequency

string

The recurring deposit frequency.

BIWEEKLY DAILY MONTHLY MONTHLY_FIRST MONTHLY_MIDDLE QUARTERLY

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://bo-api.drivewealth.io/back-office/funding/deposits \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'dw-client-app-key: {{yourAppKey}}' \
6
     --data '
7
{
8
  "currency": "USD",
9
  "type": "ACH"
10
}
11
'


xxxxxxxxxx
25
 
1
{
2
  "id": "CKDQ000001-1671085040913-DMIQY",
3
  "accountNo": "DWBG000052",
4
  "category": "DEPOSIT",
5
  "currency": "USD",
6
  "amount": 250.25,
7
  "status": "PENDING",
8
  "source": {
9
    "id": "ACH",
10
    "brand": "ACH",
11
    "meta_info": "Hey! Welcome to DriveWealth Developer Docs!"
12
  },
13
  "created": "2022-12-11T22:28:21.810Z",
14
  "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
15
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
16
  "transactionCode": "JOURNAL",
17
  "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
18
  "batch": true,
19
  "recurring": {
20
    "id": "recurring_98be6652-6361-4d4c-905b-06e9ec38d060",
21
    "nextDeposit": "2019-01-15",
22
    "active": false,
23
    "frequency": "MONTHLY_FIRST"
24
  }
25
}

200Creating a User's Account Deposit was successful.