Skip to main content
GET
List payout withdrawals

Authorizations

api-key
string
header
required

Your raw API key. Generate, rotate, and revoke keys from the merchant dashboard. Keys can optionally be bound to one or more allowed source IPs — requests from any other IP are rejected with API_KEY_IP_DENIED.

Query Parameters

status
enum<string>

Lifecycle: pending_callback → (approval callback returns 2xx) → queuedbroadcastconfirmed. Any rejection, failure, or on-chain revert resolves to refunded (funds returned to custody: sidecar re-credited, ledger reversed). refunded is the single terminal failure state — there is no separate failed step.

Available options:
pending_callback,
queued,
broadcast,
confirmed,
refunded
chain
enum<string>
Available options:
ethereum,
base,
arbitrum,
optimism,
bsc
forUserId
string<uuid>
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string

Response

OK.

requestId
string
required
success
boolean
required
data
object

Present when success: true. Shape varies per endpoint.

error
object