Skip to main content
POST
Create Payout

Authorizations

X-API-KEY
string
header
required
X-API-Nonce
string
header
required
X-API-Signature
string
header
required

Headers

X-Step-Up-Token
string

Step-up token required for Bearer/session auth (ignored for API-key auth)

Body

application/json

body

amount
string
required

Amount to send (token units as a decimal string).

Example:

"10.5"

ccy
string
required

Token/currency symbol to send.

Example:

"USDC"

chain_id
integer
required

Destination chain ID.

Example:

8453

wallet_address
string
required

Destination wallet address.

metadata
object

Optional payout metadata returned on the payment record.

reference
string

Optional client reference (max 1024 chars). Reference must be unique.

Maximum string length: 1024
token_address
string

Token contract address when not the native asset. Optional: resolved from the currency cache, and only required when the symbol maps to several tokens on the chain.

Response

OK

data
object

Response payload when the request succeeded.

error
boolean

True when the request failed.

message
string

Human-readable status or error message.