Skip to main content
POST
Cancel a pending 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"

Path Parameters

id
string<uuid>
required

Withdrawal id (UUID).

Response

201 - application/json

Updated withdrawal record (status=CANCELLED on success).

id
string<uuid>
required

Server-side withdrawal id.

userWallet
string
required

Authenticated wallet (lowercase 0x-hex).

amount
string
required

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

destination
string
required

On-chain destination EOA.

status
enum<string>
required

Lifecycle: PENDING → (MLRO_REVIEW) → CO_SIGNED → SUBMITTED → CONFIRMED. Terminal failure paths, all refunded: REJECTED (denied in compliance review), CANCELLED (user-initiated), FAILED (could not be broadcast), EXPIRED (signed deadline passed before on-chain execution). REVERTED is in the enum, but no current transition produces it.

Available options:
PENDING,
MLRO_REVIEW,
CO_SIGNED,
SUBMITTED,
CONFIRMED,
REJECTED,
REVERTED,
CANCELLED,
FAILED,
EXPIRED
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
txHash
string

0x-hex tx hash once SUBMITTED on-chain.

reason
string

Reason text for REJECTED / FAILED / CANCELLED rows.