Payout API
マーチャント残高から任意のブロックチェーンアドレスへ出金します。
Payout API を使用すると、マーチャント残高から任意のブロックチェーンアドレスへプログラム的に資金を出金できます。
すべての Payout エンドポイントでは、sign 署名の生成に専用の Payout API key を使用する必要があります。このキーは通常の API キーとは異なり、プロジェクト設定で生成する必要があります。
出金を作成する
マーチャント残高からの出金リクエストを作成します。
/v1/payoutリクエストパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
currency | string | yes | 出金通貨(References を参照) |
network | string | yes | ネットワークコード(References を参照) |
amount | string | yes | 出金額 |
to_address | string | yes | 受取人のブロックチェーンアドレス |
order_id | string | no | 冪等性キー — プロジェクト内で一意。同じ order_id で POST を再送信しても新しい出金は作成されず、既存のものが返されます |
url_callback | string | no | 出金 Webhook の URL。この出金で Webhook を無効にする場合は省略します |
memo | string | null | no | 宛先タグ/メモ。現在は TON および SOL ネットワークでのみ使用、最大 255 文字 |
from_currency | string | no | 出金時に引き落とし、currency へ自動換算するソース残高。残高を USDT のような安定コインで保持したまま、ボラタイルな資産(BTC、ETH、…)で出金できます — ボラタイルな暗号資産を自分で保有する必要はありません。"USDT" を指定すると USDT 残高から引き落とします |
fee_option | string | no | 手数料の課金方法。deduct(デフォルト) — ネットワーク手数料 + プラットフォーム手数料が amount から差し引かれ、受取人は amount - fees を受け取ります。add — 手数料が上乗せされ、マーチャントから 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 + 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"
}
}プレビュー専用。 このエンドポイントは読み取り専用です — 残高は引き落とされず、出金レコードも作成されません。UI に手数料の内訳を表示するために、必要なだけ呼び出して構いません。
出金ステータス
出金リクエストのステータスを取得します。
/v1/payout/status/{uuid}パスパラメータ
| Field | Type | Required | Description |
|---|---|---|---|
uuid | string | yes | 出金 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 で返されるフィールド:
| Field | Type | Description |
|---|---|---|
uuid | string | システムにより割り当てられた出金 UUID |
order_id | string | 内部の出金識別子(プロジェクト内で一意) |
status | string | 現在の出金ステータス(下記参照) |
currency | string | 出金通貨 |
network | string | ネットワークコード |
amount | string | リクエストされた出金額 |
merchant_amount | string | マーチャント残高から引き落とされた金額 |
network_amount | string | 実際にオンチェーンで送信された金額(ネットワーク手数料 + プラットフォーム手数料控除後) |
amount_usd | string | 出金額の USD 換算 |
to_address | string | 受取人のブロックチェーンアドレス |
memo | string | null | 宛先タグ/メモ(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 フィールドは以下の値を取り得ます:
| Status | Description |
|---|---|
pending | 作成済み、処理待ち |
completed | 正常に完了 — txid が設定される |
failed | 送信エラー — error_type を参照 |
cancelled | キャンセル済み |
エラータイプ
status = failed の場合、error_type フィールドが理由を示します:
| Code | Description |
|---|---|
aml_risk | AML リスクチェックにより出金がブロックされました(受取アドレスが高リスクとしてフラグ付け) |
Webhook 通知
出金のステータスが変化すると、システムは出金作成時に渡された url_callback URL に POST Webhook を送信します。url_callback が指定されていない場合、その出金には Webhook は送信されません。
- Method:
POST - Content-Type:
application/json - Signature: リクエストボディの
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 と同じアルゴリズムを使用しますが、通常の API キーではなく Payout API key で署名します。sign フィールドを取り除き、残りのペイロードを JSON エンコードし、Base64 エンコードしてから hash_hmac('sha256', $base64, $payoutApiKey) を計算し、受信した sign と比較してください。