Skip to main content
POST
Initiate a withdrawal

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. multi_wallet partners must additionally send X-User-Wallet: 0x<40-hex> on every authenticated request to declare the acting wallet. See the API keys guide for scope taxonomy, partner kinds, rate limits, and rotation procedure.

Headers

X-User-Wallet
string

Required for multi_wallet partners on every authenticated request; ignored for single_wallet. Declares the acting end-user wallet for this request — drives KYC checks, balances/positions/orders attribution, rate-limit buckets, and audit. Lower-cased server-side. Missing on a multi_wallet key → 401 api_key_user_wallet_required; malformed → 401 api_key_user_wallet_invalid. The on-chain CTFExchange/Vault contracts still verify EIP-712 signer ↔ vault binding, so loosening API-layer attribution is safe by construction.

Pattern: ^0x[a-fA-F0-9]{40}$
Example:

"0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb3"

Body

application/json
amount
string
required

USDC amount in human-readable decimal (NOT wei).

Example:

"125.50"

destination
string
required

Destination EOA (0x + 40 hex). When the platform enforces withdrawal security and the wallet has a withdrawal whitelist (/api/me/withdrawal-security/whitelist), the destination must be on it, otherwise 403 withdrawal_address_not_whitelisted. Destinations are screened for sanctions and AML.

salt
string
required

Per-user unique uint256 salt (decimal string).

expiry
integer
required

EIP-712 expiry, Unix seconds.

Required range: x >= 0
Example:

1729511712

userSig
string
required

EIP-712 signature over { token, amount, destination, salt, deadline } against the user's vault EIP-712 domain. See Withdrawals EIP-712.

totpCode
string

Withdrawal 2FA code. Required when the wallet has 2FA active and the platform enforces withdrawal security — else 403 totp_required. A 6-digit TOTP or a 16-hex backup code; single-use. Omit when 2FA is not configured. See Withdrawal 2FA.

Example:

"123456"

Response

Accepted into a routing state, or rejected in-body. Read status: an uppercase value is the created withdrawal's status, except REJECTED with an empty id (refused before a record was created, reason in reason); rejected comes with code.

Routing outcome. Lowercase values (rejected, mlro_review) come from the API's pre-checks, before any withdrawal record is created. Uppercase values are the created withdrawal record's status, except REJECTED with an empty id: the request was refused before a record was created (for example insufficient balance), with the reason in reason.

status
enum<string>
required
Available options:
PENDING,
MLRO_REVIEW,
CO_SIGNED,
SUBMITTED,
CONFIRMED,
REJECTED,
rejected,
mlro_review
id
string<uuid>

Created withdrawal id when status is uppercase (record exists); an empty string on REJECTED, which creates no record.

code
string

Present when status is rejected: wallet_banned (destination is not eligible; comes with reason_public), aml_blocked (destination failed AML screening), restriction_active (an account restriction blocks withdrawals).

reason
string

Human-readable rejection reason.

reason_public
string

Neutral public reason sent instead of reason on a wallet_banned rejection.