Skip to content

POST /v1/payouts

POST
/v1/payouts

Creates a new payout to the specified address.

The payout is created in Pending status and processed asynchronously.
The Payout Worker will broadcast the on-chain transaction and update status.

Requires Idempotency-Key header (recommended: UUID v4).

授权

bearer_auth

API key authentication. Use sk_test_... for sandbox or sk_live_... for production.

类型
HTTP (bearer)

参数

请求头参数

Idempotency-Key*

Unique key for idempotent requests (recommended: UUID v4)

类型
string
必填

请求体

application/json
JSON
{
  
"amount": "10.50",
  
"currency": "USDT",
  
"description": "Affiliate commission for January",
  
"metadata": "string",
  
"network": "string",
  
"to_address": "TJn9bXhJMVn1Do3PfFHg5J3YNYN9hPQBqA"
}

响应

Payout created

application/json
JSON
{
  
"amount": "10",
  
"completed_at": "string",
  
"created_at": "2026-02-27T08:30:00+00:00",
  
"currency": "USDT",
  
"description": "Affiliate commission for January",
  
"error_reason": "string",
  
"fee": "1.5",
  
"id": "po_a1b2c3d4e5f6",
  
"livemode": false,
  
"net_amount": "8.5",
  
"network": "TRON",
  
"reviewed_at": "string",
  
"reviewed_by": "string",
  
"status": "string",
  
"sub_merchant_code": "shop_tokyo",
  
"to_address": "TJn9bXhJMVn1Do3PfFHg5J3YNYN9hPQBqA",
  
"tx_hash": "string"
}

试验场

服务器
授权
请求头
主体

示例

技术支持 VitePress OpenAPI