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.

Allowed:
string
enum
required

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

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.

Allowed:
string
enum

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

string
enum

The recurring deposit frequency.

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

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 days ago