Payout API
Отправка выплат с баланса мерчанта на любой блокчейн-адрес.
Payout API позволяет программно выводить средства с баланса мерчанта на любой блокчейн-адрес.
Для всех endpoint'ов Payout вы должны использовать отдельный Payout API key для расчёта подписи sign. Этот ключ отличается от обычного API key и создаётся в настройках проекта.
Создать выплату
Создаёт запрос на выплату с баланса мерчанта.
/v1/payoutПараметры запроса
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
currency | string | да | Валюта вывода (см. References) |
network | string | да | Код сети (см. References) |
amount | string | да | Сумма вывода |
to_address | string | да | Блокчейн-адрес получателя |
order_id | string | нет | Ключ идемпотентности — уникальный в рамках проекта. Повторный POST с тем же order_id не создаёт новую выплату — возвращается уже существующая |
url_callback | string | нет | URL для webhook'ов выплаты. Не указывайте, чтобы отключить 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 - комиссии. add — комиссии добавляются сверху, с мерчанта списывается amount + комиссии, получателю приходит ровно amount |
Идемпотентность. В рамках проекта выплата уникальна по order_id. Повторная отправка POST с тем же order_id безопасна — 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 - комиссии). Передайте fee_option: add, чтобы взимать комиссии сверху — получатель получит ровно amount, а с мерчанта спишется amount + комиссии.
Рассчитать выплату
Оценивает суммы и комиссии вывода без создания выплаты и без списания с баланса. Используйте, чтобы показать пользователю точную сумму, которую он получит (или заплатит), до подтверждения.
/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)
Поля ответа
Поля, возвращаемые в result для POST /v1/payout и GET /v1/payout/status/{uuid}:
| Поле | Тип | Описание |
|---|---|---|
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 | Destination tag / memo (TON, SOL). Иначе null |
txid | string | null | Хеш транзакции в блокчейне. null, пока транзакция не отправлена |
block_number | int | null | Номер блока, в который включена транзакция. null, пока не включена |
error_type | string | null | Причина при status = failed (см. «Типы ошибок» ниже). Иначе null |
created_at | string (ISO 8601) | Время создания выплаты |
updated_at | string (ISO 8601) | Время последнего изменения статуса |
from_currency | string | null | Исходный баланс, с которого было списание при авто-конвертации (например, USDT для выплаты в BTC). 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-уведомления
При смене статуса выплаты система отправляет POST webhook на URL url_callback, переданный при создании выплаты. Если url_callback не был указан, webhook'и для этой выплаты не отправляются.
- Метод:
POST - Content-Type:
application/json - Подпись: поле
signв теле запроса, рассчитанное с использованием Payout API key (тот же ключ, которым подписываются запросы на выплату).
Payload повторяет объект result из GET /v1/payout/status/{uuid} плюс поле sign для проверки.
Payload
{
"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, сериализуйте оставшийся payload в JSON, закодируйте в Base64, затем рассчитайте hash_hmac('sha256', $base64, $payoutApiKey) и сравните с полученным sign.