На странице
Создание
Создавайте вывод с баланса токена на кошелёк из белого списка, выбирайте сеть, подписывайте запрос и отслеживайте состояние.
API-ключ: Payout
Вывод необратим после отправки в сеть. Дважды проверьте destination_address и network перед подтверждением. Возвратного платежа в блокчейне не бывает: ошибка в адресе — это потерянные средства.
Вывод не ставится в очередь на расчётный день: исполнение начинается сразу после приёма запроса. Сколько перевод будет идти дальше, зависит от самой сети и её загрузки в этот момент.
Тело запроса
| Параметр | Тип | Обязателен | Описание |
|---|---|---|---|
amount |
string | Да | Сумма вывода десятичной строкой (например, "100.00") |
currency |
string | Да | Символ криптоактива. Вывести можно любой актив, по которому есть баланс; набор сетей зависит от актива (см. Поддерживаемые валюты) |
network |
string | Да | Код сети вывода — TRC20, ERC20, BEP20, POLYGON, ARBITRUM, OPTIMISM, BASE, TON, AVAX, SOL или PLASMA. Это 11 сетей из 13, принимающих платежи: NEAR и SUI работают только на приём, адрес в них в белый список не добавить (см. Поддерживаемые валюты) |
destination_address |
string | Да | Адрес кошелька получателя. Должен быть заранее добавлен в белый список адресов вывода этого мерчанта |
external_order_id |
string | Да | Ваш идентификатор вывода (макс. 200 символов), уникальный в рамках мерчанта. Используется для идемпотентности: повторный вызов с тем же значением вернёт уже созданный вывод, а не отправит средства ещё раз |
Пример запроса
{
"amount": "100.00",
"currency": "USDT",
"network": "TRC20",
"destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
"external_order_id": "payout-001"
}
Примеры кода
В каждой вкладке используется официальный SDK с Payout-ключом. Подпись, сериализацию, безопасные повторы и типизированные ошибки обрабатывает SDK.
API_KEY_ID="rk_live_xxxxxxxxxxxx"
API_SECRET="sk_live_xxxxxxxxxxxx"
BODY='{"destination_address":"TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9","network":"TRC20","currency":"USDT","amount":"50.00","external_order_id":"payout-123"}'
TS=$(date +%s)
BODY_HASH=$(printf '%s' "$BODY" | openssl dgst -sha256 -hex | sed 's/^.* //')
SIGNATURE=$(printf '%s\n%s\n%s\n%s\n%s' "$TS" POST /v1/withdrawals '' "$BODY_HASH" \
| openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)
curl -sS https://api.paymos.io/v1/withdrawals \
-H "Authorization: HMAC-SHA256 $API_KEY_ID:$SIGNATURE" \
-H "X-Request-Timestamp: $TS" \
-H "Content-Type: application/json" \
-d "$BODY"
import { Paymos, externalOrderId } from '@paymos/sdk';
const paymos = new Paymos({
apiKey: process.env.PAYMOS_PAYOUT_KEY,
apiSecret: process.env.PAYMOS_API_SECRET,
});
const withdrawal = await paymos.withdrawals.create({
destinationAddress: 'TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9',
network: 'TRC20',
currency: 'USDT',
amount: '50.00',
externalOrderId: externalOrderId('payout'),
});
console.log(withdrawal.withdrawalId, withdrawal.status);
import os
from paymos import Paymos
paymos = Paymos(
api_key=os.environ["PAYMOS_PAYOUT_KEY"],
api_secret=os.environ["PAYMOS_API_SECRET"],
)
withdrawal = paymos.withdrawals.create(
destination_address="TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
network="TRC20",
currency="USDT",
amount="50.00",
external_order_id="payout-001",
)
print(withdrawal["withdrawal_id"], withdrawal["status"])
<?php
use Paymos\Client;
use Paymos\ClientConfig;
use Paymos\IdempotencyKey;
$paymos = new Client(new ClientConfig(
getenv('PAYMOS_PAYOUT_KEY'),
getenv('PAYMOS_API_SECRET')
));
$withdrawal = $paymos->withdrawals()->create(array(
'destination_address' => 'TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9',
'network' => 'TRC20',
'currency' => 'USDT',
'amount' => '50.00',
'external_order_id' => IdempotencyKey::externalOrderId('payout'),
));
echo $withdrawal['withdrawal_id'] . ' ' . $withdrawal['status'];
package main
import (
"context"
"fmt"
"os"
paymos "github.com/Paymos-labs/go-sdk/v2"
)
func main() {
client, err := paymos.NewClient(os.Getenv("PAYMOS_PAYOUT_KEY"), os.Getenv("PAYMOS_API_SECRET"))
if err != nil {
panic(err)
}
withdrawal, err := client.Withdrawals.Create(context.Background(), paymos.CreateWithdrawalParams{
DestinationAddress: "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
Network: "TRC20",
Currency: "USDT",
Amount: "50.00",
ExternalOrderID: "payout-001",
})
if err != nil {
panic(err)
}
fmt.Println(withdrawal.WithdrawalID, withdrawal.Status)
}
using Paymos;
using var paymos = new PaymosClient(
Environment.GetEnvironmentVariable("PAYMOS_PAYOUT_KEY")!,
Environment.GetEnvironmentVariable("PAYMOS_API_SECRET")!);
var withdrawal = await paymos.Withdrawals.CreateAsync(new CreateWithdrawalRequest(
DestinationAddress: "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
Network: "TRC20",
Currency: "USDT",
Amount: "50.00",
ExternalOrderId: "payout-001"));
Console.WriteLine($"{withdrawal.WithdrawalId} {withdrawal.Status}");
import io.paymos.CreateWithdrawalRequest;
import io.paymos.PaymosClient;
import io.paymos.Withdrawal;
PaymosClient paymos = new PaymosClient(
System.getenv("PAYMOS_PAYOUT_KEY"),
System.getenv("PAYMOS_API_SECRET"));
Withdrawal withdrawal = paymos.withdrawals.create(new CreateWithdrawalRequest(
"TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
"TRC20",
"USDT",
"50.00",
"payout-001"));
System.out.println(withdrawal.withdrawalId() + " " + withdrawal.status());
require 'paymos'
paymos = Paymos::Client.new(
api_key: ENV.fetch('PAYMOS_PAYOUT_KEY'),
api_secret: ENV.fetch('PAYMOS_API_SECRET')
)
withdrawal = paymos.withdrawals.create(
destination_address: 'TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9',
network: 'TRC20',
currency: 'USDT',
amount: '50.00',
external_order_id: 'payout-001'
)
puts "#{withdrawal.withdrawal_id} #{withdrawal.status}"
use paymos::{CreateWithdrawalRequest, PaymosClient};
let paymos = PaymosClient::new(
std::env::var("PAYMOS_PAYOUT_KEY")?,
std::env::var("PAYMOS_API_SECRET")?,
)?;
let withdrawal = paymos
.withdrawals()
.create(&CreateWithdrawalRequest {
destination_address: "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9".to_owned(),
network: "TRC20".to_owned(),
currency: "USDT".to_owned(),
amount: "50.00".to_owned(),
external_order_id: "payout-001".to_owned(),
})
.await?;
println!("{} {}", withdrawal.withdrawal_id, withdrawal.status);
Ответ (201 Created / 200 при идемпотентном совпадении)
{
"withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
"external_order_id": "payout-001",
"status": "created",
"is_final": false,
"is_test": true,
"amount": "100.00",
"currency": "USDT",
"network": "TRC20",
"destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
"created_at": 1739289600
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
withdrawal_id |
string | Идентификатор вывода с префиксом (wdr_...) |
external_order_id |
string | Ваш собственный идентификатор вывода, возвращённый из запроса на создание |
status |
string | Статус вывода (snake_case — см. Статусы вывода) |
is_final |
boolean | true, когда вывод достиг терминального состояния (completed, failed, cancelled) |
is_test |
boolean | true для выводов в тестовом режиме |
amount |
string | Сумма вывода |
fee |
string? | Фиксированная комиссия за вывод для этого токена, в том же активе, что и amount. Величина берётся из каталога токенов платформы и от текущей цены газа не зависит: она субсидирована и ниже сетевой стоимости этого маршрута, комиссии Paymos в ней нет. Поле необязательное — обрабатывайте и случай, когда его нет |
currency |
string | Символ криптоактива |
network |
string | Код сети блокчейна |
destination_address |
string | Адрес получателя |
tx_hash |
string? | Хеш транзакции, которой уходит вывод. Заполняется, как только эта транзакция появилась в сети, — то есть раньше completed |
explorer_url |
string? | Прямая ссылка на транзакцию в блок-эксплорере сети (Tronscan / Etherscan / Tonviewer и т. п.). Заполняется только когда задан tx_hash и для сети настроен блок-эксплорер. Можно выводить как есть — это готовая кликабельная ссылка. |
created_at |
integer | Unix timestamp, секунды |
completed_at |
integer? | Время завершения |
failed_at |
integer? | Время ошибки |
cancelled_at |
integer? | Время отмены |
Идемпотентность
Всегда отправляйте external_order_id при создании вывода. Повторный вызов с тем же external_order_id возвращает уже созданный вывод — не вторую отправку. Статус ответа — 200 OK (без заголовка Location) при идемпотентном совпадении и 201 Created для нового вывода.
Это ваша страховка от нестабильной сети, сбоя фоновых процессов и циклов повторов. Используйте тот же id для того же вывода; новый id — для нового.
Ошибки
Payment-ключ (pk_) получает 403 payout_key_required — но только на правильно составленном запросе: тело разбирают раньше, чем проверяют тип ключа, поэтому запрос без тела или со сломанным JSON сначала получит 400. См. Коды ошибок — полный каталог. URI в поле type каждой ошибки ведёт сразу на нужную строку.