Skip to main content
POST
Return USDC sent to the vault by a plain transfer to the owner wallet (RND-2019)

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"

Query Parameters

vault
string

One of the caller's vaults from GET /api/me/vault vaults[]. Default: the active vault. 404 vault_not_found otherwise.

Response

The call met the vault's return job just after it ended.

Relay job tracking the return of stray USDC sent to a vault address.

jobId
string
required

Relay job id; poll GET /api/me/vault/stray-usdc/return/{jobId}.

vaultAddress
string
required

The vault the USDC is returned from (lowercase 0x-hex).

status
enum<string>
required

pending / building / submitted: in progress. confirmed: transaction mined — USDC returned to owner wallet. expired: nothing sent. failed_permanent: see failureKind.

Available options:
pending,
building,
submitted,
confirmed,
failed_permanent,
expired
txHash
string | null
required

Transaction hash once broadcast.

failureKind
enum<string> | null
required

Set on failed_permanent only.

Available options:
reverted,
submission_failed,
null
nothingToReturn
boolean
required

true when the job ended without a transaction because the vault held no stray USDC anymore by execution time.

requestedAt
string<date-time>
required
confirmedAt
string<date-time> | null
required
generation
enum<integer>
required

Contract generation of the vault.

Available options:
1,
2
strayUsdc
string | null
required

The stray USDC read on chain before the job was queued (decimal string). Null when answering an in-flight job.

Example:

"1950"

enqueued
boolean
required

true when this call queued the job; false when answering a job already in flight.