Withdrawals

Update Withdrawal

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.

patch/funding/redemptions/{redemptionID}

Request

Base URL
https://bo-api.drivewealth.io/back-office
URL
https://bo-api.drivewealth.io/back-office/funding/redemptions/{redemptionID}
Auth
HTTP bearer

Path parameters

redemptionIDstring required

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

Example:ZZZZ009001-1234567890137-4X5Y6

Request body

status'REJECTED' | 'RIA_REJECTED'

The status transition being requested for the withdrawal.

statusCommentstring

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

amountnumber

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.

settlementProfileIDstring

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

metadataMetadataMoneyMovement

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.

Example request

{
  "status": "REJECTED",
  "statusComment": "Rejected",
  "amount": 125.92,
  "settlementProfileID": "settlement-profile-bank-account-1",
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Response

Updating the Withdrawal was successful. No content is returned.

Changes

No recorded changes to this operation across all 1 revision of this API.