Update Withdrawal

Updates a Withdrawal by redemptionID.

Path Params
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.

string
enum

The status transition being requested for the withdrawal.

Show Details
PENDINGThe withdrawal details were accepted.
ON_HOLDThe withdrawal details were accepted, but it is not yet ready to be processed.
APPROVEDThe withdrawal was approved.
REJECTEDThe withdrawal was rejected.
RIA_APPROVEDApproved once cash has settled against the managed account via AutoPilot.
RIA_REJECTEDRejected because there is not enough cash in the account after selling securities to cover the withdrawal.
SUCCESSFULThe withdrawal was successful. Not settable via this endpoint for withdrawals processed via Modern Treasury.
FAILEDThe withdrawal was not successful.
string

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

number

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

string
enum

The transaction code identifying how/why the funds were posted. Valid values depend on the transaction types configured for the partner. May be absent if no transaction code was assigned.

Show Details
DISBURSEMENT_ACH_BMOCash disbursement via ACH, routed through BMO.
DISBURSEMENT_ACH_JPMCash disbursement via ACH, routed through JPMorgan.
DISBURSEMENT_ACH_MTCash disbursement via ACH, routed through Modern Treasury.
DISBURSEMENT_ACH_RETURN_MTReturn of an ACH disbursement routed through Modern Treasury.
DISBURSEMENT_BULK_FUNDINGCash disbursement via bulk or instant funding.
DISBURSEMENT_CASH_PROMOTIONCash disbursement from the partner's promotion account to fund a cash promotion.
DISBURSEMENT_CASH_TRANSFERCash disbursement via an internal cash transfer.
DISBURSEMENT_WIRE_JPMCash disbursement via wire, routed through JPMorgan.
DISBURSEMENT_WIRE_MTCash disbursement via wire, routed through Modern Treasury.
DISBURSEMENT_WIRE_RETURN_JPMReturn of a wire disbursement routed through JPMorgan.
DISBURSEMENT_WIRE_RETURN_MTReturn of a wire disbursement routed through Modern Treasury.
FEE_AUMAssets-under-management (AUM) fee, collected from the account as a cash transfer redemption.
JOURNALBulk or instant funding posted as a cash journal rather than a cash receipt/disbursement, depending on partner configuration.
RECEIPT_ACH_BMOCash receipt via ACH, routed through BMO.
RECEIPT_ACH_JPMCash receipt via ACH, routed through JPMorgan.
RECEIPT_ACH_MTCash receipt via ACH, routed through Modern Treasury.
RECEIPT_ACH_RETURN_MTReturn of an ACH receipt routed through Modern Treasury.
RECEIPT_BULK_FUNDINGCash receipt via bulk or instant funding.
RECEIPT_CASH_PROMOTIONCash receipt into the customer's account from a cash promotion.
RECEIPT_CASH_TRANSFERCash receipt via an internal cash transfer.
RECEIPT_WIRE_JPMCash receipt via wire, routed through JPMorgan.
RETIREMENT_CONTRIBUTION_ACH_APIIRA contribution via ACH pull.
RETIREMENT_CONTRIBUTION_ACH_API_RETURNReturn of an IRA contribution made via ACH pull.
RETIREMENT_CONTRIBUTION_ACH_VRNIRA contribution received via ACH into the account's virtual bank account.
RETIREMENT_CONTRIBUTION_BULK_FUNDINGIRA contribution via bulk or instant funding.
RETIREMENT_CONTRIBUTION_CASH_TRANSFERIRA contribution via an internal cash transfer.
RETIREMENT_CONTRIBUTION_WIRE_VRNIRA contribution received via wire into the account's virtual bank account.
RETIREMENT_DISTRIBUTION_ACH_APIIRA distribution via ACH push.
RETIREMENT_DISTRIBUTION_ACH_API_RETURNReturn of an IRA distribution made via ACH push.
RETIREMENT_DISTRIBUTION_WIRE_MANUALIRA distribution via wire that required manual approval.
string
deprecated

Deprecated. Use transactionCode instead.

boolean
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
LoadingLoading…
Response
Choose an example:
application/json