Skip to main content
POST
Create new deposit request

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"

lifetime
number

1.4.0: срок жизни депозита в секундах (окно мониторинга адреса). По умолчанию — окно сети из настроек (обычно 24 ч). Диапазон 300 с … 30 дней. По истечении депозит получает статус expired (оживляется через POST /deposits/{uuid}/refresh, если tx всё же пришла).

Required range: 300 <= x <= 2592000
Example:

3600

accuracyPaymentPercent
number

1.4.0: допуск недоплаты в процентах именно для этого депозита (Heleket accuracy_payment_percent): received ≥ expected × (1 − N/100) считается оплаченным (paid). По умолчанию — настройка сайта / платформы.

Required range: 0 <= x <= 100
Example:

1

allowTopUp
boolean

1.4.0: режим доплаты. При недоплате депозит остаётся открытым до конца окна мониторинга: клиент досылает недостающую сумму на тот же адрес, суммы складываются (wrong_amount → paid). В ответе — объект topUp с remainingAmount и списком доплат. По умолчанию — настройка сайта.

Example:

true

urlCallback
string

1.4.0: webhook-URL именно для этого депозита (вместо callback_url сайта). Публичный http(s) хост.

Example:

"https://shop.example.com/webhooks/wallet"

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 | null
required

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

network
string
required

1.4.0: сеть актива.

Example:

"TRON"

isFinal
boolean
required

1.4.0: терминальный ли статус — можно прекращать поллинг.

Example:

false

amountUsd
string | null
required

1.4.0: оценка суммы в USD (полученной, иначе ожидаемой).

Example:

"100.50"

rateUsd
string | null
required

1.4.0: курс актива к USD на момент ответа.

Example:

"1.00"

commission
string | null
required

1.4.0: комиссия обменника (если учёт включён и депозит финализирован).

Example:

"0.50"

createdAt
string<date-time>
required

1.4.0: время создания депозита.

updatedAt
string<date-time>
required

1.4.0: время последнего изменения статуса.

accuracyPaymentPercent
string | null
required

1.4.0: допуск недоплаты (%) для этого депозита; null — по настройкам сайта/платформы.

Example:

"1.00"

allowTopUp
boolean
required

1.4.0: режим доплаты включён.

Example:

false

topUp
object | null
required

1.4.0: состояние режима доплаты (null, если выключен).

staticAddress
object | null
required

1.4.0: платёж на статический адрес — ссылка на родительский адрес (null для обычных депозитов).

refund
object | null
required

1.4.0: последняя выплата-возврат депозита (null — возврат не запрашивался).