Payout API
Wysyłaj wypłaty z salda sprzedawcy na dowolny adres blockchain.
Payout API umożliwia programowe wypłacanie środków z salda sprzedawcy na dowolny adres blockchain.
Dla wszystkich endpointów Payout musisz używać osobnego Payout API key do generowania podpisu sign. Klucz ten różni się od zwykłego klucza API i należy go wygenerować w ustawieniach projektu.
Utwórz wypłatę
Tworzy żądanie wypłaty z Twojego salda sprzedawcy.
/v1/payoutParametry żądania
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
currency | string | tak | Waluta wypłaty (zobacz References) |
network | string | tak | Kod sieci (zobacz References) |
amount | string | tak | Kwota wypłaty |
to_address | string | tak | Adres blockchain odbiorcy |
order_id | string | nie | Klucz idempotentności — unikalny w obrębie projektu. Powtórne POST z tym samym order_id nie tworzy nowej wypłaty — zamiast tego zwracana jest istniejąca |
url_callback | string | nie | URL webhooków wypłaty. Pomiń, aby wyłączyć webhooki dla tej wypłaty |
memo | string | null | nie | Tag docelowy / memo. Obecnie używany wyłącznie przez sieci TON i SOL; maks. 255 znaków |
from_currency | string | nie | Saldo źródłowe, z którego pobrane środki zostaną automatycznie przeliczone na currency w momencie wypłaty. Pozwala wypłacać w aktywach o dużej zmienności (BTC, ETH, …) przy jednoczesnym utrzymywaniu salda w stablecoinie takim jak USDT — nie musisz sam trzymać zmiennej kryptowaluty. Przekaż "USDT", aby obciążyć saldo USDT |
fee_option | string | nie | Sposób naliczania opłat. deduct (domyślnie) — opłaty sieciowe i opłaty platformy odejmowane są od amount, odbiorca otrzymuje amount - fees. add — opłaty doliczane są na wierzch, sprzedawca obciążany jest kwotą amount + fees, a odbiorca otrzymuje dokładnie amount |
Idempotentność. W obrębie projektu wypłata jest unikalna względem order_id. Ponowne wysłanie tego samego żądania POST z tym samym order_id jest bezpieczne — API zwraca istniejącą wypłatę zamiast tworzyć duplikat. Dla wypłat produkcyjnych zawsze przekazuj order_id.
Przykłady żądań
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()
}Przykład odpowiedzi
{
"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"
}
}Opłaty. Domyślnie fee_option: deduct — opłaty sieciowe oraz opłaty platformy odejmowane są od amount (odbiorca otrzymuje amount - fees). Przekaż fee_option: add, aby naliczyć opłaty na wierzch — odbiorca otrzymuje dokładnie amount, a sprzedawca obciążany jest kwotą amount + fees.
Oblicz wypłatę
Szacuje kwoty i opłaty wypłaty bez tworzenia wypłaty i bez obciążania salda. Użyj, aby pokazać użytkownikowi dokładną kwotę, którą otrzyma (lub zapłaci), zanim potwierdzi.
/v1/payout/calcParametry żądania
Identyczne jak w Utwórz wypłatę — te same pola, ten sam podpis. Pola order_id, url_callback, to_address i memo są akceptowane, ale ignorowane: żadna wypłata nie jest zapisywana i nie są wysyłane callbacki.
Przykład żądania
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"}'Przykład odpowiedzi
{
"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"
}
}Tylko podgląd. Ten endpoint jest tylko do odczytu — żadne saldo nie jest obciążane i nie tworzy się rekord wypłaty. Wywołuj go tyle razy, ile potrzebujesz, aby pokazać rozbicie opłat w UI.
Status wypłaty
Pobierz status żądania wypłaty.
/v1/payout/status/{uuid}Parametry ścieżki
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
uuid | string | tak | UUID wypłaty (z pola result.uuid przy tworzeniu) |
Przykład odpowiedzi
{
"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"
}
}Dla tego żądania GET podpis jest obliczany z pustej treści:
hash_hmac('sha256', base64_encode(''), $apiKey)
Pola odpowiedzi
Pola zwracane w result z POST /v1/payout oraz GET /v1/payout/status/{uuid}:
| Pole | Typ | Opis |
|---|---|---|
uuid | string | UUID wypłaty przypisany przez system |
order_id | string | Twój wewnętrzny identyfikator wypłaty (unikalny w obrębie projektu) |
status | string | Aktualny status wypłaty (zobacz poniżej) |
currency | string | Waluta wypłaty |
network | string | Kod sieci |
amount | string | Żądana kwota wypłaty |
merchant_amount | string | Kwota obciążająca saldo sprzedawcy |
network_amount | string | Kwota faktycznie wysłana w sieci (po opłatach sieciowych i opłatach platformy) |
amount_usd | string | Równowartość kwoty wypłaty w USD |
to_address | string | Adres blockchain odbiorcy |
memo | string | null | Tag docelowy / memo (TON, SOL). W przeciwnym razie null |
txid | string | null | Hash transakcji blockchain. null, dopóki transakcja nie zostanie wysłana |
block_number | int | null | Numer bloku, w którym uwzględniono transakcję. null, dopóki transakcja nie zostanie uwzględniona |
error_type | string | null | Powód niepowodzenia, gdy status = failed (zobacz „Typy błędów" poniżej). W przeciwnym razie null |
created_at | string (ISO 8601) | Czas utworzenia wypłaty |
updated_at | string (ISO 8601) | Czas ostatniej zmiany statusu |
from_currency | string | null | Saldo źródłowe, z którego pobrano wypłatę przy użyciu automatycznej konwersji (np. USDT dla wypłaty w BTC). null, jeśli konwersja nie nastąpiła |
debited_amount | string | null | Kwota faktycznie obciążająca saldo źródłowe po konwersji. Obecne tylko, gdy używana jest automatyczna konwersja |
debited_currency | string | null | Waluta debited_amount — saldo, z którego zostały pobrane środki |
Statusy wypłat
Pole status może przyjmować następujące wartości:
| Status | Opis |
|---|---|
pending | Utworzona, oczekuje na przetworzenie |
completed | Zakończona pomyślnie — txid jest ustawione |
failed | Błąd wysyłki — zobacz error_type |
cancelled | Anulowana |
Typy błędów
Gdy status = failed, pole error_type opisuje przyczynę:
| Kod | Opis |
|---|---|
aml_risk | Wypłata zablokowana przez kontrole ryzyka AML (adres odbiorcy oznaczony jako wysokiego ryzyka) |
Powiadomienia webhook
Gdy zmienia się status wypłaty, system wysyła webhook POST pod adres url_callback przekazany w momencie utworzenia wypłaty. Jeśli url_callback nie został podany, dla tej wypłaty nie są wysyłane żadne webhooki.
- Method:
POST - Content-Type:
application/json - Signature: pole
signw treści żądania, obliczone za pomocą Payout API key (tego samego klucza, którym podpisywane są żądania wypłat).
Payload odzwierciedla obiekt result z GET /v1/payout/status/{uuid} wraz z dodatkowym polem sign służącym do weryfikacji.
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"
}Weryfikacja podpisu. Użyj tego samego algorytmu co dla webhooków płatności, ale podpisz Payout API key zamiast zwykłego klucza API. Usuń pole sign, zakoduj pozostały payload jako JSON, zakoduj go w base64, następnie oblicz hash_hmac('sha256', $base64, $payoutApiKey) i porównaj z otrzymanym sign.