Skip to main content
POST
/
v1
/
public
/
deposits
Create new deposit request
curl --request POST \
  --url https://api.example.com/v1/public/deposits \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "assetCode": "USDT_TRC20",
  "orderId": "order_42_abc",
  "expectedAmount": "100.50",
  "comment": "User #42 deposit"
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "order_42_abc",
  "address": "TXYZ...abcd",
  "memo": "WP-1A2B3C4D",
  "assetCode": "USDT_TRC20",
  "expectedAmount": "100.50",
  "status": "check",
  "expiresAt": "2023-11-07T05:31:56Z",
  "explorerAddressUrl": "https://tronscan.org/#/address/TXYZ",
  "transaction": {
    "networkStatus": "confirmed",
    "receivedAmount": "100.500000",
    "txhash": "a1b2c3...e9f0",
    "confirmations": 12,
    "requiredConfirmations": 19,
    "blockNumber": "65123456",
    "explorerTxUrl": "https://tronscan.org/#/transaction/a1b2c3",
    "detectedAt": "2023-11-07T05:31:56Z",
    "paidAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-Signature
string
header
required

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

Body

application/json
​
assetCode
string
required
Example:

"USDT_TRC20"

​
orderId
string

order_id обменника. Уникален per site_id + asset. Если не указан — генерируется автоматически (уникальный код вида NNNN-NNNN-NNNN).

Example:

"order_42_abc"

​
expectedAmount
string

Ожидаемая сумма как decimal-строка. По умолчанию — мин. сумма приёма валюты (asset.minDepositAmount).

Example:

"100.50"

​
comment
string

Опциональный комментарий

Example:

"User #42 deposit"

Response

201 - application/json

Депозит создан (или возвращён существующий).

​
uuid
string<uuid>
required

Публичный идентификатор депозита (используйте в GET /{uuid}).

​
orderId
string
required

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

Example:

"order_42_abc"

​
address
string
required

Адрес для оплаты. Для memo-based сетей (TON) — общий приёмный адрес + memo.

Example:

"TXYZ...abcd"

​
memo
string | null
required

Memo/comment (ОБЯЗАТЕЛЕН для memo-based сетей, иначе null).

Example:

"WP-1A2B3C4D"

​
assetCode
string
required
Example:

"USDT_TRC20"

​
expectedAmount
string
required

Ожидаемая сумма (string). 0 = принимаем любую сумму.

Example:

"100.50"

​
status
enum<string>
required

Бизнес-статус депозита (полный набор). Поток: check → process → confirm_check → paid | paid_over | wrong_amount. Терминальные/прочие: expired (окно мониторинга истекло), cancel, fail, system_fail, refund_process → refund_paid | refund_fail.

Available options:
check,
process,
confirm_check,
paid,
paid_over,
wrong_amount,
expired,
cancel,
fail,
system_fail,
refund_process,
refund_paid,
refund_fail
Example:

"check"

​
expiresAt
string<date-time>
required

До какого момента сеть мониторится на оплату.

​
explorerAddressUrl
string | null
required

Ссылка на адрес в explorer.

Example:

"https://tronscan.org/#/address/TXYZ"

​
transaction
object
required

On-chain данные incoming-транзакции. null пока депозит не получил ни одной tx.