Skip to main content
GET
/
v1
/
public
/
payouts
/
by-order-id
/
{orderId}
Get payout by your order_id
curl --request GET \
  --url https://api.example.com/v1/public/payouts/by-order-id/{orderId} \
  --header 'X-Signature: <api-key>'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "payout_77",
  "status": "queued",
  "assetCode": "USDT_TRC20",
  "destinationAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
  "destinationMemo": null,
  "amount": "50.000000",
  "requiresApproval": false,
  "txHash": "a1b2c3...e9f0",
  "confirmations": 12,
  "requiredConfirmations": 19,
  "networkStatus": "confirmed",
  "explorerTxUrl": "https://tronscan.org/#/transaction/a1b2c3",
  "failReason": "<string>",
  "approvedAt": "2023-11-07T05:31:56Z",
  "broadcastedAt": "2023-11-07T05:31:56Z",
  "confirmedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Signature
string
header
required

HMAC-SHA256-Hex(timestamp + "." + raw_body, api_secret)

Path Parameters

orderId
string
required

Ваш order_id, переданный при создании.

Response

200 - application/json
uuid
string<uuid>
required

Публичный идентификатор выплаты.

orderId
string
required

Ваш order_id (label).

Example:

"payout_77"

status
enum<string>
required

Бизнес-статус выплаты (полный набор). Поток: new → pending_approval → approved → queued → signing → broadcasted → confirmed. Терминальные: rejected (отклонена оператором), failed (ошибка broadcast/revert), cancelled (отменена до подписи).

Available options:
new,
pending_approval,
approved,
rejected,
queued,
signing,
broadcasted,
confirmed,
failed,
cancelled
Example:

"queued"

assetCode
string
required
Example:

"USDT_TRC20"

destinationAddress
string
required

Адрес получателя.

Example:

"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t"

destinationMemo
string | null
required

Memo получателя (для memo-based сетей), иначе null.

Example:

null

amount
string
required

Сумма выплаты (string).

Example:

"50.000000"

requiresApproval
boolean
required

Требуется ли ручное одобрение оператором.

Example:

false

txHash
string | null
required

Хеш исходящей blockchain-tx (после broadcast). null пока не отправлена.

Example:

"a1b2c3...e9f0"

confirmations
number | null
required

Текущее число подтверждений сети для исходящей tx. null пока не отправлена.

Example:

12

requiredConfirmations
number | null
required

Сколько подтверждений нужно для финализации (asset.minConfirmations). null пока не отправлена.

Example:

19

networkStatus
enum<string> | null
required

On-chain статус исходящей tx: pending → mempool → confirmed | fail. null пока не отправлена.

Available options:
pending,
mempool,
confirmed,
fail
Example:

"confirmed"

explorerTxUrl
string | null
required

Ссылка на исходящую tx в explorer.

Example:

"https://tronscan.org/#/transaction/a1b2c3"

failReason
string | null
required

Причина ошибки (для status=failed/rejected/cancelled), иначе null.

approvedAt
string<date-time> | null
required

Когда выплата одобрена оператором. null если ещё не одобрена / auto-approve.

broadcastedAt
string<date-time> | null
required

Когда tx отправлена в сеть (broadcast). null пока не отправлена.

confirmedAt
string<date-time> | null
required

Когда выплата подтверждена сетью. null пока не подтверждена.

createdAt
string<date-time>
required

Время создания выплаты.

updatedAt
string<date-time>
required

Время последнего обновления.