Create Withdrawal

Creates a Withdrawal.

Body Params
string
required

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

number
required

The amount of the withdrawal. Accepts positive or negative values; regardless of the sign provided, the withdrawal is stored and processed as a negative amount in the system.

string
enum
required

The name of the currency in abbreviation form.

Allowed:
string
enum
required

The method/form in which the redemption/withdrawal will be sent back to the user's external account.

Allowed:
string

The unique DriveWealth identifier that identifies each linked bank account.

details
object

The necessary recipient details for completing a wire payment

string
enum

The type of redemption/withdrawal from an IRA type of account.

Note: Trump accounts follow specific requirements for external account transfers or distributions. Click here for more details.

string
enum

These types are only applicable for the distribution type EARLY_DISTRIBUTION_PENALTY_EXCEPTION. Click here for more details.",

Allowed:
iraTaxWithholdings
object
boolean

True, if the account is a managed account and a full liquidation is requested from the user.

fees
array

A list of fees associated to the withdrawal.

fees
string

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

string

For ACH, this field will be passed through on an addenda record used for additional remittance details to make it easier for a recipient to identify and apply payments. For wire payments, the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. This tag provides specific details about the purpose of the payment to the beneficiary. Character limit vary by bank and rail. Typical limits are 80 characters for ach payments and 140 characters for wire payments.

string

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

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.

Response

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