提现 API
通过编程方式将商户余额提现到任意区块链地址。
提现 API 让您可以通过编程方式将商户余额发送到任意区块链地址。
所有提现端点必须使用单独的 Payout API key 来生成 sign 签名。该密钥与常规 API key 不同,需在项目设置中单独生成。
创建提现
从商户余额创建一笔提现请求。
/v1/payout请求参数
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
currency | string | 是 | 提现币种(详见 References) |
network | string | 是 | 网络代码(详见 References) |
amount | string | 是 | 提现金额 |
to_address | string | 是 | 收款方区块链地址 |
order_id | string | 否 | 幂等性键——在项目内唯一。携带相同 order_id 的重复 POST 不会创建新提现,而是返回已存在的提现 |
url_callback | string | 否 | 提现 webhook URL。不传则不发送任何 webhook |
memo | string | null | 否 | destination tag / memo。目前仅 TON 与 SOL 网络使用;最大 255 字符 |
from_currency | string | 否 | 提现时从该源余额扣款并自动兑换为 currency。允许您以波动性资产(BTC、ETH、…)发起提现,同时将余额保留为稳定币 USDT —— 您无需自己持有波动性加密货币。传入 "USDT" 即可从 USDT 余额扣款 |
fee_option | string | 否 | 手续费扣除方式。deduct(默认)——网络与平台手续费从 amount 中扣除,收款方收到 amount - fees;add——手续费在 amount 之外加收,从商户余额扣除 amount + fees,收款方恰好收到 amount |
幂等性。 在同一项目内,提现按 order_id 唯一。携带相同 order_id 的重复 POST 是安全的——API 会返回已存在的提现而不会创建副本。生产环境务必传入 order_id。
请求示例
curl -X POST https://api.2328.io/api/v1/payout \
-H "Content-Type: application/json" \
-H "User-Agent: MyShop/1.0 (+https://myshop.example)" \
-H "project: YOUR_PROJECT_UUID" \
-H "sign: YOUR_HMAC_SIGNATURE" \
-d '{"currency":"TRX","network":"TRX-TRC20","amount":"1.00","to_address":"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t","order_id":"9ed25264-8be4-439f-acf5-2a8732538d27","url_callback":"https://your-site.com/webhook/payout","memo":null,"fee_option":"deduct"}'<?php
function apiSign(string $body, string $apiKey): string {
return hash_hmac('sha256', base64_encode($body), $apiKey);
}
$project = 'YOUR_PROJECT_UUID';
$apiKey = 'YOUR_PAYOUT_API_KEY';
$data = [
'currency' => 'TRX',
'network' => 'TRX-TRC20',
'amount' => '1.00',
'to_address' => 'TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t',
'order_id' => '9ed25264-8be4-439f-acf5-2a8732538d27',
'url_callback' => 'https://your-site.com/webhook/payout',
'memo' => null,
'fee_option' => 'deduct',
];
$body = json_encode($data, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
$sign = apiSign($body, $apiKey);
$ch = curl_init('https://api.2328.io/api/v1/payout');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'User-Agent: MyShop/1.0 (+https://myshop.example)',
"project: $project",
"sign: $sign",
],
]);
$response = json_decode(curl_exec($ch), true);import { createHmac } from "crypto";
function apiSign(body, apiKey) {
const base64 = Buffer.from(body, "utf8").toString("base64");
return createHmac("sha256", apiKey).update(base64).digest("hex");
}
const PROJECT_UUID = "YOUR_PROJECT_UUID";
const PAYOUT_API_KEY = process.env.PAYOUT_API_KEY;
const data = {
currency: "TRX",
network: "TRX-TRC20",
amount: "1.00",
to_address: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
order_id: "9ed25264-8be4-439f-acf5-2a8732538d27",
url_callback: "https://your-site.com/webhook/payout",
memo: null,
fee_option: "deduct",
};
const body = JSON.stringify(data);
const sign = apiSign(body, PAYOUT_API_KEY);
const res = await fetch("https://api.2328.io/api/v1/payout", {
method: "POST",
headers: {
"Content-Type": "application/json",
"User-Agent": "MyShop/1.0 (+https://myshop.example)",
project: PROJECT_UUID,
sign,
},
body,
});
const json = await res.json();import json
import hmac
import hashlib
import base64
import httpx
def api_sign(body: str, api_key: str) -> str:
b64 = base64.b64encode(body.encode("utf-8")).decode()
return hmac.new(api_key.encode(), b64.encode(), hashlib.sha256).hexdigest()
PROJECT_UUID = "YOUR_PROJECT_UUID"
PAYOUT_API_KEY = "YOUR_PAYOUT_API_KEY"
data = {
"currency": "TRX",
"network": "TRX-TRC20",
"amount": "1.00",
"to_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"order_id": "9ed25264-8be4-439f-acf5-2a8732538d27",
"url_callback": "https://your-site.com/webhook/payout",
"memo": None,
"fee_option": "deduct",
}
body = json.dumps(data, separators=(",", ":"), ensure_ascii=False)
sign = api_sign(body, PAYOUT_API_KEY)
r = httpx.post(
"https://api.2328.io/api/v1/payout",
headers={
"Content-Type": "application/json",
"User-Agent": "MyShop/1.0 (+https://myshop.example)",
"project": PROJECT_UUID,
"sign": sign,
},
content=body.encode("utf-8"),
)
response = r.json()package main
import (
"bytes"
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"encoding/hex"
"encoding/json"
"net/http"
)
func apiSign(body []byte, apiKey string) string {
b64 := base64.StdEncoding.EncodeToString(body)
h := hmac.New(sha256.New, []byte(apiKey))
h.Write([]byte(b64))
return hex.EncodeToString(h.Sum(nil))
}
func marshalCanonical(v any) ([]byte, error) {
var buf bytes.Buffer
enc := json.NewEncoder(&buf)
enc.SetEscapeHTML(false)
if err := enc.Encode(v); err != nil {
return nil, err
}
return bytes.TrimRight(buf.Bytes(), "\n"), nil
}
type CreatePayout struct {
Currency string `json:"currency"`
Network string `json:"network"`
Amount string `json:"amount"`
ToAddress string `json:"to_address"`
OrderID string `json:"order_id"`
URLCallback string `json:"url_callback"`
Memo *string `json:"memo"`
FeeOption string `json:"fee_option"`
}
func main() {
const projectUUID = "YOUR_PROJECT_UUID"
const payoutAPIKey = "YOUR_PAYOUT_API_KEY"
data := CreatePayout{
Currency: "TRX",
Network: "TRX-TRC20",
Amount: "1.00",
ToAddress: "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
OrderID: "9ed25264-8be4-439f-acf5-2a8732538d27",
URLCallback: "https://your-site.com/webhook/payout",
Memo: nil,
FeeOption: "deduct",
}
body, err := marshalCanonical(data)
if err != nil {
panic(err)
}
sign := apiSign(body, payoutAPIKey)
req, _ := http.NewRequest("POST",
"https://api.2328.io/api/v1/payout",
bytes.NewReader(body))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("User-Agent", "MyShop/1.0 (+https://myshop.example)")
req.Header.Set("project", projectUUID)
req.Header.Set("sign", sign)
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
}响应示例
{
"state": 0,
"result": {
"uuid": "019dea62-1727-72aa-ac2c-eaf2ade193ef",
"order_id": "9ed25264-8be4-439f-acf5-2a8732538d27",
"status": "pending",
"currency": "TRX",
"network": "TRX-TRC20",
"amount": "1.00",
"merchant_amount": "1",
"network_amount": "0.89",
"amount_usd": "0.33",
"to_address": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
"memo": null,
"txid": null,
"block_number": null,
"error_type": null,
"created_at": "2026-05-02T23:29:50+03:00",
"updated_at": "2026-05-02T23:29:50+03:00"
}
}手续费。 默认 fee_option: deduct —— 网络与平台手续费从 amount 中扣除(收款方收到 amount - fees)。传 fee_option: add 则手续费在 amount 之外加收 —— 收款方恰好收到 amount,商户被扣 amount + fees。
计算提现
在 不创建提现 也不扣除余额的情况下,估算提现金额与手续费。可在用户确认之前展示其将实际收到(或支付)的精确金额。
/v1/payout/calc请求参数
与 创建提现 完全一致 —— 字段相同,签名相同。order_id、url_callback、to_address 和 memo 也会被接受但被忽略:不会持久化任何提现,也不会发送 callback。
请求示例
curl -X POST https://api.2328.io/api/v1/payout/calc \
-H "Content-Type: application/json" \
-H "User-Agent: MyShop/1.0 (+https://myshop.example)" \
-H "project: YOUR_PROJECT_UUID" \
-H "sign: YOUR_HMAC_SIGNATURE" \
-d '{"currency":"USDT","network":"TRX-TRC20","amount":"100","fee_option":"add"}'响应示例
{
"state": 0,
"result": {
"currency": "USDT",
"network": "TRX-TRC20",
"amount": "100",
"fee_option": "add",
"merchant_amount": "103.00000000",
"network_amount": "100",
"total_fee": "3.00000000",
"total_fee_usd": "3.00000000"
}
}仅预览。 该接口是只读的 —— 不会扣除任何余额,也不会创建提现记录。可以随意调用,在你的界面中渲染手续费明细。
提现状态
获取一笔提现请求的当前状态。
/v1/payout/status/{uuid}路径参数
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
uuid | string | 是 | 提现 UUID(创建时来自 result.uuid) |
响应示例
{
"state": 0,
"result": {
"uuid": "019dff1f-0dbd-7277-8d45-271e7775388f",
"order_id": "4dfdcc84402b1185b71cbe399321533e",
"status": "completed",
"currency": "TRX",
"network": "TRX-TRC20",
"amount": "3.00",
"merchant_amount": "3.00",
"network_amount": "3.00",
"amount_usd": "1.04",
"to_address": "THauRv5tcucQRohXg8NiyGTk16DX1XQG5x",
"memo": null,
"txid": "9242e533703704ef3eaba840f70b4a26333e72c943377ee375fea17badb53def",
"block_number": null,
"error_type": null,
"created_at": "2026-05-07T00:08:38+03:00",
"updated_at": "2026-05-07T00:08:54+03:00",
"from_currency": "USDT",
"debited_amount": "1.050735",
"debited_currency": "USDT"
}
}该 GET 请求使用空请求体计算签名:
hash_hmac('sha256', base64_encode(''), $apiKey)
响应字段
POST /v1/payout 与 GET /v1/payout/status/{uuid} 返回的 result 包含以下字段:
| 字段 | 类型 | 描述 |
|---|---|---|
uuid | string | 系统分配的提现 UUID |
order_id | string | 您提供的提现标识符(项目内唯一) |
status | string | 当前提现状态(详见下文) |
currency | string | 提现币种 |
network | string | 网络代码 |
amount | string | 请求的提现金额 |
merchant_amount | string | 从商户余额扣除的金额 |
network_amount | string | 实际链上发送的金额(扣除网络与平台手续费后) |
amount_usd | string | 提现金额的美元等值 |
to_address | string | 收款方区块链地址 |
memo | string | null | destination tag / memo(TON、SOL)。其他网络为 null |
txid | string | null | 链上交易哈希。提交链上前为 null |
block_number | int | null | 交易所在区块高度。包含进区块前为 null |
error_type | string | null | status = failed 时的失败原因(详见下文 Error types);其他情况为 null |
created_at | string (ISO 8601) | 提现创建时间 |
updated_at | string (ISO 8601) | 状态最近一次更新时间 |
from_currency | string | null | 使用自动兑换时,提现实际扣款的源余额(例如 BTC 提现的 USDT)。未发生兑换时为 null |
debited_amount | string | null | 转换后实际从源余额扣除的金额。仅在使用自动转换时存在 |
debited_currency | string | null | debited_amount 对应的扣款币种 |
提现状态值
status 字段可取以下值:
| 状态 | 描述 |
|---|---|
pending | 已创建,等待处理 |
completed | 已成功完成 — txid 已设置 |
failed | 发送失败 — 详情见 error_type |
cancelled | 已取消 |
错误类型
当 status = failed 时,error_type 字段说明失败原因:
| 代码 | 描述 |
|---|---|
aml_risk | 提现被 AML 风控拦截(收款地址被标记为高风险) |
Webhook 通知
当提现的 status 发生变化时,系统会向创建提现时传入的 url_callback 发送 POST webhook。如果未提供 url_callback,则不会为该笔提现发送任何 webhook。
- 方法:
POST - Content-Type:
application/json - 签名: 请求体中的
sign字段,使用 Payout API key(与签名提现请求时使用的密钥相同)计算。
载荷与 GET /v1/payout/status/{uuid} 的 result 对象一致,并额外包含一个 sign 字段用于校验。
载荷
{
"uuid": "019dff1f-0dbd-7277-8d45-271e7775388f",
"order_id": "4dfdcc84402b1185b71cbe399321533e",
"status": "completed",
"currency": "TRX",
"network": "TRX-TRC20",
"amount": "3.00",
"merchant_amount": "3.00",
"network_amount": "3.00",
"amount_usd": "1.04",
"to_address": "THauRv5tcucQRohXg8NiyGTk16DX1XQG5x",
"memo": null,
"txid": "9242e533703704ef3eaba840f70b4a26333e72c943377ee375fea17badb53def",
"block_number": null,
"error_type": null,
"created_at": "2026-05-07T00:08:38+03:00",
"updated_at": "2026-05-07T00:08:54+03:00",
"from_currency": "USDT",
"debited_amount": "1.050735",
"debited_currency": "USDT",
"sign": "925ad7bf3d6841864101f7cc2c7e30652e70a06cdb04dbe07a0129480000ce4a"
}校验签名: 与支付 webhook 算法相同,但使用 Payout API key 而不是普通 API key。移除 sign 字段,将剩余载荷转为 JSON、Base64 编码,再计算 hash_hmac('sha256', $base64, $payoutApiKey) 与收到的 sign 比较。