Update Withdrawal

patch

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

Updates a Withdrawal by redemptionID. Partners can reject a PENDING withdrawal; RIA-managed withdrawals use RIA_REJECTED instead. Updates that the caller is not permitted to make return a 403 response.

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.

Show Details

REJECTED	The withdrawal was rejected. Partners may use this only to reject a currently PENDING withdrawal.
RIA_REJECTED	Rejected because there is not enough cash in the account after selling securities to cover the withdrawal. Only valid for RIA-managed accounts, from RIA_PENDING or RIA_APPROVED.

Allowed:

statusComment

string

A comment describing the status change. Must be sent together with status; sending only one of them returns a 400.

amount

number

The updated withdrawal amount. Only supported for RIA-managed withdrawals in RIA_PENDING or RIA_APPROVED status; any other withdrawal returns a 400. Cannot be changed once a financial transaction has been submitted for processing.

settlementProfileID

string

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

metadata

object

sensitive
The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

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

403Forbidden