--- updatedAt: 2026-05-27T16:58:23.000Z agentTools: projectIndex: https://developer.drivewealth.com/apis/llms.txt --- # List User Withdrawals Retrieves a list of User Withdrawals by userID. # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Money Movement APIs", "version": "2026-10-08", "contact": { "email": "producteng@drivewealth.tech" } }, "servers": [ { "url": "https://bo-api.drivewealth.io/back-office", "description": "Sandbox (No Real World Financial/Trading Impact)" }, { "url": "https://bo-api.drivewealth.net/back-office", "description": "Production" } ], "security": [ { "bearerAuth": [] } ], "x-readme": { "explorer-enabled": false, "headers": [ { "key": "dw-client-app-key", "value": "{{yourAppKey}}" } ] }, "tags": [ { "name": "Withdrawals" } ], "paths": { "/users/{userID}/funding/redemptions": { "get": { "tags": [ "Withdrawals" ], "summary": "List User Withdrawals", "description": "Retrieves a list of User Withdrawals by userID.", "parameters": [ { "in": "path", "name": "userID", "schema": { "$ref": "#/components/schemas/userID" }, "required": true, "example": "123e4567-e89b-12d3-a456-000000000004", "description": "The User's unique identifier." }, { "in": "query", "name": "status", "schema": { "type": "string" }, "example": "Successful,Pending", "description": "Comma separated payment statuses" }, { "in": "query", "name": "type", "schema": { "type": "string" }, "example": "ACH,WIRE,BULK_FUNDING", "description": "Comma separated deposit types" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 25 }, "example": 50, "description": "The number of deposits to be returned per page. Minimum=1, Maximum=100" }, { "in": "query", "name": "offset", "schema": { "type": "string" }, "example": "11AA000001-1234567890128-RJJLU", "description": "Should either be null or the last payment result in the previous request" } ], "responses": { "200": { "description": "Retrieving a list of User Withdrawals by userID was Successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Redemptions" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" }, "examples": { "Limit should be greater than 0": { "value": { "errorCode": "E025", "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be greater than 0." } }, "Limit should be less than or equal to 100": { "value": { "errorCode": "E025", "message": "Invalid or badly formatted request. Refer to the API documentation for details. Details: Invalid value: limit. Limit should be less than or equal to 100" } } } } } } } } } }, "components": { "schemas": { "ErrorCode": { "type": "string", "description": "The error code that is returned when an error occurs.", "example": "E032" }, "ErrorCodeMessage": { "type": "string", "description": "The error message that is returned when an error occurs." }, "ErrorDetails": { "type": "object", "properties": { "field": { "type": "string", "description": "JSON field name from the request body that caused an error" }, "type": { "type": "string", "enum": [ "STRING", "ARRAY", "INT", "DECIMAL", "BOOL", "TEXT", "UUID", "DATE", "MAP", "OBJECT", "ENUM" ], "description": "Expected data type of the field", "x-enumDescriptions": { "STRING": "The value is a string.", "ARRAY": "The value is an array.", "INT": "The value is an integer.", "DECIMAL": "The value is a decimal number.", "BOOL": "The value is a boolean.", "TEXT": "The value is free-form text.", "UUID": "The value is a UUID.", "DATE": "The value is a date.", "MAP": "The value is a key-value map.", "OBJECT": "The value is an object.", "ENUM": "The value is one of a fixed set of enumerated values." } }, "allowedValues": { "type": "string", "description": "Example values which are allowed in the field" }, "detail": { "type": "string", "description": "Additional validation or error details for the field" } } }, "ErrorResponseModel": { "type": "object", "description": "The error response model that is returned when an error occurs.", "required": [ "errorCode", "message" ], "properties": { "errorCode": { "$ref": "#/components/schemas/ErrorCode" }, "message": { "$ref": "#/components/schemas/ErrorCodeMessage" }, "errorDetails": { "$ref": "#/components/schemas/ErrorDetails" } } }, "userID": { "type": "string", "example": "123e4567-e89b-12d3-a456-000000000004", "description": "A unique identifier created for each User on DriveWealth's platform." }, "accountID": { "type": "string", "example": "123e4567-e89b-12d3-a456-000000000004.1234567890125", "description": "The user's unique account identifier." }, "accountNo": { "type": "string", "example": "FFFF000005", "description": "The user's unique account number, that is human readable." }, "accountTypeObject": { "type": "object", "properties": { "name": { "type": "string", "example": "LIVE", "description": "The type of account that has been created." }, "description": { "type": "string", "example": "Live Account", "description": "A custom description of the account type." } } }, "accountManagementTypeObject": { "type": "object", "properties": { "name": { "type": "string", "example": "SELF", "description": "The type of account who has trading authority.", "enum": [ "SELF", "ADVISORY", "RIA_MANAGED", "CUSTODIAL", "CUSTODIAL_MANAGED", "RESERVE", "RETIREMENT_TRADITIONAL_SELF", "RETIREMENT_TRADITIONAL_ADVISORY", "RETIREMENT_TRADITIONAL_RIA_MANAGED", "RETIREMENT_ROTH_SELF", "RETIREMENT_ROTH_ADVISORY", "RETIREMENT_ROTH_RIA_MANAGED", "TRUST_SELF", "TRUST_ADVISORY", "TRUST_RIA_MANAGED", "HSA_SELF", "HSA_ADVISORY", "HSA_RIA_MANAGED", "BUSINESS_SELF", "BUSINESS_ADVISORY", "BUSINESS_RIA_MANAGED", "TRUMP_SELF" ], "x-enumDescriptions": { "SELF": "A user directs trades in their own account without advice.", "ADVISORY": "An Investment Advisor or Investment Advisor Representative has access to the account, but trades are placed only with the user's authorization.", "RIA_MANAGED": "An Investment Advisor has discretion to place trades in the account.", "CUSTODIAL": "An account held for the benefit of a minor.", "CUSTODIAL_MANAGED": "A custodial account with discretionary trading managed by an advisor.", "RESERVED": "Reserved for future use; not currently assigned.", "RETIREMENT_TRADITIONAL_SELF": "A self-directed Traditional IRA retirement account.", "RETIREMENT_TRADITIONAL_ADVISORY": "A Traditional IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.", "RETIREMENT_TRADITIONAL_RIA_MANAGED": "A Traditional IRA retirement account with discretionary trading managed by an advisor.", "RETIREMENT_ROTH_SELF": "A self-directed Roth IRA retirement account.", "RETIREMENT_ROTH_ADVISORY": "A Roth IRA retirement account accessible to an advisor, with trades placed only by the user's authorization.", "RETIREMENT_ROTH_RIA_MANAGED": "A Roth IRA retirement account with discretionary trading managed by an advisor.", "TRUST_SELF": "A self-directed Trust account.", "TRUST_ADVISORY": "A Trust account accessible to an advisor, with trades placed only by the user's authorization.", "TRUST_RIA_MANAGED": "A Trust account with discretionary trading managed by an advisor.", "HSA_SELF": "A self-directed Health Savings Account.", "HSA_ADVISORY": "A Health Savings Account accessible to an advisor, with trades placed only by the user's authorization.", "HSA_RIA_MANAGED": "A Health Savings Account with discretionary trading managed by an advisor.", "BUSINESS_SELF": "A self-directed Business account.", "BUSINESS_ADVISORY": "A Business account accessible to an advisor, with trades placed only by the user's authorization.", "BUSINESS_RIA_MANAGED": "A Business account with discretionary trading managed by an advisor.", "TRUMP_SELF": "A self-directed Trump account." } }, "description": { "type": "string", "example": "Self Directed Account", "description": "A custom description of the account management type." } } }, "feeTransactionCode": { "description": "The transaction code of the fee. State income tax withholding uses either the generic `FEE_STATE_TAX` code or a per-state code of the form `FEE_STATE_TAX_`, where `` is the two-letter state code (e.g. `FEE_STATE_TAX_CA`), depending on partner configuration.", "example": "FEE_ACH", "oneOf": [ { "type": "string", "title": "Fee code", "enum": [ "FEE_ACH", "FEE_WIRE", "FEE_WIRE_DOMESTIC", "FEE_WIRE_INTERNATIONAL", "FEE_FEDERAL_TAX", "FEE_STATE_TAX" ], "x-enumDescriptions": { "FEE_ACH": "An ACH transfer fee.", "FEE_WIRE": "A wire transfer fee.", "FEE_WIRE_DOMESTIC": "A domestic wire transfer fee.", "FEE_WIRE_INTERNATIONAL": "An international wire transfer fee.", "FEE_FEDERAL_TAX": "U.S. federal income tax withholding.", "FEE_STATE_TAX": "U.S. state income tax withholding, when a per-state `FEE_STATE_TAX_` code is not used." } }, { "type": "string", "title": "Per-state tax withholding code", "pattern": "^FEE_STATE_TAX_[A-Z]{2}$", "example": "FEE_STATE_TAX_CA", "description": "U.S. state income tax withholding for a specific state, where the suffix is the two-letter state code." } ] }, "wlpFinTranTypeID": { "type": "string", "example": "123e4567-e89b-12d3-a456-00000000004c", "description": "A unique identifier to id different type of transactions." }, "currency": { "type": "string", "example": "USD", "description": "The name of the currency in abbreviation form.", "enum": [ "USD" ], "x-enumDescriptions": { "USD": "U.S. Dollar." } }, "currencySymbol": { "type": "string", "example": "$", "description": "The currency symbol.", "enum": [ "$" ], "x-enumDescriptions": { "$": "U.S. Dollar symbol." } }, "currencyObject": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/currency" }, "description": { "type": "string", "example": "US Dollar", "description": "A custom description about the currency." }, "symbol": { "$ref": "#/components/schemas/currencySymbol" } } }, "finTranReference": { "type": "string", "example": "HG.123e4567-e89b-12d3-a456-00000000004e", "description": "The unique identifier that references back to the specific transaction." }, "redemptionID": { "type": "string", "example": "ZZZZ009001-1234567890137-4X5Y6", "description": "A unique identifier for the user's account redemption/withdrawal." }, "redemptionStatusObject": { "type": "object", "properties": { "id": { "type": "number", "example": 1, "description": "The current status of the user's brokerage account withdraw in integer form." }, "message": { "type": "string", "example": "PENDING", "description": "The current status of the user's brokerage account redemption/withdrawal.", "enum": [ "STARTED", "PENDING", "SUCCESSFUL", "FAILED", "OTHER", "RIA_PENDING", "RIA_APPROVED", "RIA_APPROVED", "APPROVED", "REJECTED", "-" ], "x-enumDescriptions": { "STARTED": "A new withdrawal request was received.", "PENDING": "The withdrawal details were accepted.", "SUCCESSFUL": "The withdrawal was successful.", "FAILED": "The withdrawal was not successful.", "OTHER": "The withdrawal is in a suspended state.", "RIA_PENDING": "The withdrawal is being handled by the RIA (AutoPilot) and the details were accepted.", "RIA_APPROVED": "Approved once cash has settled against the managed account via AutoPilot.", "APPROVED": "The withdrawal was approved.", "REJECTED": "The withdrawal was rejected.", "-": "An error occurred during the withdrawal." } }, "updated": { "type": "string", "example": "2022-12-11T22:28:21.810Z", "description": "The last updated timestamp of the status of the user's brokerage account redemption/withdrawal." } } }, "feeObject": { "type": "object", "required": [ "type", "amount" ], "properties": { "type": { "description": "The type of fee that is being applied.", "allOf": [ { "$ref": "#/components/schemas/feeTransactionCode" } ] }, "description": { "type": "string", "example": "Fee - ACH", "description": "A custom description that describes the fee type." }, "amount": { "type": "number", "example": -5.99, "description": "The amount of the fee that is being applied." }, "wlpFinTranTypeID": { "$ref": "#/components/schemas/wlpFinTranTypeID" }, "transactionCode": { "$ref": "#/components/schemas/feeTransactionCode" }, "finTranReference": { "$ref": "#/components/schemas/finTranReference" }, "created": { "type": "string", "example": "2022-12-11T22:28:21.810Z", "description": "The timestamp of when the fee was charged." }, "currency": { "$ref": "#/components/schemas/currency" }, "symbol": { "$ref": "#/components/schemas/currencySymbol" } } }, "Redemption": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/redemptionID" }, "paymentID": { "$ref": "#/components/schemas/redemptionID" }, "amount": { "type": "number", "example": 250.25, "description": "The amount that will be withdraw from the user's brokerage account." }, "currency": { "$ref": "#/components/schemas/currencyObject" }, "status": { "$ref": "#/components/schemas/redemptionStatusObject" }, "accountDetails": { "type": "object", "properties": { "accountID": { "$ref": "#/components/schemas/accountID" }, "accountNo": { "$ref": "#/components/schemas/accountNo" }, "accountType": { "$ref": "#/components/schemas/accountTypeObject" }, "accountManagementType": { "$ref": "#/components/schemas/accountManagementTypeObject" } } }, "fees": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/feeObject" } ] } }, "wlpFinTranTypeID": { "$ref": "#/components/schemas/wlpFinTranTypeID" }, "finTranReference": { "$ref": "#/components/schemas/finTranReference" }, "timestamp": { "type": "string", "example": "2022-12-11T22:28:21.810Z", "description": "The date and time of when the redemption was created." } } }, "Redemptions": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/Redemption" } ] } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } } ``` # Sibling pages * [List Account Withdrawals](https://developer.drivewealth.com/apis/reference/get_accounts-accountid-funding-redemptions.md) * [Create Withdrawal](https://developer.drivewealth.com/apis/reference/post_funding-redemptions.md) * [Retrieve Withdrawal](https://developer.drivewealth.com/apis/reference/get_funding-redemptions-redemptionid.md) * [Withdrawal Status](https://developer.drivewealth.com/apis/reference/redemption-status.md) * [List Withdrawals](https://developer.drivewealth.com/apis/reference/get_funding-redemptions.md) * [Update Withdrawal](https://developer.drivewealth.com/apis/reference/patch_funding-redemptions-redemptionid.md)