Creates a new withdrawal request from the specified account’s wallet. Supports ACH via Plaid and Wire transfer methods.
HTTP Basic Authentication using the API Key as username and API Secret as password.
A unique key to ensure idempotency of the request. If a request with the same idempotency key has already been processed, the original response will be returned.
The unique identifier of the investor account.
The withdrawal amount as a decimal string with up to 2 decimal places.
^\d+(\.\d{1,2})?$"500.00"
The funding method for the withdrawal:
ach_plaid: ACH transfer via Plaid to connected bankwire: Wire transfer (future)ach_plaid, wire "ach_plaid"
The currency code (ISO 4217). Defaults to USD.
3"USD"
Optional description for the withdrawal.
500"Monthly withdrawal to checking account"
Options for Plaid ACH withdrawals. Requires a previously connected Plaid item.
Options for wire withdrawals. (Future implementation)
{}Withdrawal initiated successfully
Withdrawal record returned by the API.
Unique identifier for the withdrawal.
"wdr_a1b2c3d4e5f6g7h8"
The investor account ID associated with the withdrawal.
"3d0b0e65-35d3-4dcd-8df7-10286ebb4b4b"
The wallet ID from which funds are withdrawn.
"wal_x1y2z3a4b5c6d7e8"
The funding method used.
ach_plaid, wire "ach_plaid"
Current status of the withdrawal:
pending: Awaiting processingprocessing: Being processedsubmitted: Submitted to external providercompleted: Funds sent successfullycanceled: Cancelled by user or systemfailed: Transfer failedpending, processing, submitted, completed, canceled, failed "processing"
The withdrawal amount.
"500.00"
The currency code.
"USD"
User-provided description.
"Monthly payout"
Method-specific details. For ach_plaid, includes Plaid transfer information.
{
"plaidTransferId": "trf_xyz789",
"plaidAccountId": "acc_abc123"
}Details about the destination bank account.
{
"bankName": "Chase Bank",
"accountMask": "****5678"
}When the withdrawal was initiated.
"2026-01-17T09:00:00.000Z"
When the withdrawal was submitted to the external provider.
"2026-01-17T10:00:00.000Z"
When the withdrawal was completed and funds sent.
"2026-01-18T12:00:00.000Z"
Reason for failure, if applicable.
"Invalid bank account"
When the withdrawal record was created.
"2026-01-17T08:00:00.000Z"