Update Withdrawal

patch

https://bo-api.drivewealth.io/back-office/funding/redemptions/{redemptionID}

Updates a Withdrawal by redemptionID.

Path Params

redemptionID

string

required

A unique identifier for the user's account redemption/withdrawal.

Body Params

All fields are optional. Only fields present in the request body are updated; omitted fields are left unchanged.

status

string

enum

The status transition being requested for the withdrawal. Unlike the broader lifecycle status returned by GET, only these values are accepted for update; any other value (including STARTED, RIA_PENDING, OTHER, or the response-only "-" error state) is rejected.

Show Details

PENDING	The withdrawal details were accepted.
ON_HOLD	The withdrawal details were accepted, but it is not yet ready to be processed.
APPROVED	The withdrawal was approved.
REJECTED	The withdrawal was rejected.
RIA_APPROVED	Approved once cash has settled against the managed account via AutoPilot.
RIA_REJECTED	Rejected because there is not enough cash in the account after selling securities to cover the withdrawal.
SUCCESSFUL	The withdrawal was successful. Not settable via this endpoint for withdrawals processed via Modern Treasury.
FAILED	The withdrawal was not successful.

statusComment

string

A comment describing the status change. Stored on the withdrawal's status history.

amount

number

The updated withdrawal amount. Cannot be changed once a financial transaction has been submitted for processing.

transactionCode

string

enum

Show Details

JOURNAL	An internal journal entry moving funds or securities without external settlement.
FEE_ACH	A fee charged via ACH.
DISBURSEMENT_ACH_SVB	A disbursement sent via ACH through Silicon Valley Bank (SVB).

Allowed:

wlpFinTranTypeID

string

deprecated

Deprecated. Use transactionCode instead.

batch

boolean

settlementProfileID

string

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

metadata

object

The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes.

fees

array of objects

Fee line items to add to the withdrawal.

fees

Responses

204

Updating the Withdrawal was successful. No content is returned.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

400Bad Request