Skip to main content
POST
Get withdrawal signing data
Get the data a user must sign to request a withdrawal.
Use a Broker API Key and pass the target user’s wallet in X-User-Wallet-Address. The gateway checks that the wallet belongs to your Broker. See Broker API Key and signing.

Usage notes

  • address is the user’s bound signing wallet and the withdrawal destination. to_address is optional; if provided, it must equal address. This platform API does not support third-party withdrawal destinations.
  • For EVM, response data is hex-encoded EIP-712 TypedData for wallet signing, not onchain transaction data. Do not broadcast it to contract_address.
  • timestamp is a Unix timestamp in milliseconds. After signing, pass the signature components and the unchanged timestamp to Submit a withdrawal.

Authorizations

KEY
string
header
required

Broker API Key

Timestamp
string
header
required

Unix timestamp in seconds

SIGN
string
header
required

Hexadecimal HMAC-SHA512 signature generated with the Broker Secret Key

Headers

X-User-Wallet-Address
string
required

Target user's wallet address. The gateway verifies that the user belongs to the current Broker.

Body

application/json
chain
enum<string>
required

Network identifier: base, bsc, ethereum, solana, or arbitrum.

Available options:
base,
bsc,
ethereum,
solana,
arbitrum
Example:

"ethereum"

token_symbol
string
required

Token symbol

token_address
string
required

Token contract

token_amount
string
required

Withdrawal amount as a decimal string

address
string
required

Bound user wallet that signs the request; must match X-User-Wallet-Address

to_address
string

Optional. If provided, it must equal the bound signing wallet address; third-party withdrawal destinations are not supported.

Response

Successful

code
integer

Business code; 0 indicates success

Example:

0

message
string

Human-readable message; success responses use success

Example:

"success"

reason
string

Error reason identifier; usually empty on success

trace_id
string

Trace ID to provide when requesting support

data
object