Расчет суммы вывода

post
https://api.heleket.com/v1/payout/calc
Copy

Запрос

Параметры запроса

ИмяТип параметраЗначение по умолчаниюОписание
amount*stringСумма выплаты
address*stringАдрес кошелька, на который будет произведен вывод средств
currency*stringКод валюты для выплатыЕсли валюта является фиатной, то требуется параметр to_currency.
to_currencyКод криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже
networkstringСетевой код блокчейнаНе требуется, если валюта/to_currency является криптовалютой и имеет только одну сеть, например BTC
is_subtract*booleanОпределяет, откуда будет удерживаться комиссия за вывод средствtrue - с вашего балансаfalse - начиная с суммы выплаты, сумма выплаты будет уменьшена
course_sourcestringДоступные значенияBinanceBinanceP2pExmoKucoinЗначение из настроек продавцаСервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца.
prioritystringmin: 4max: 11Доступные значенияrecommendedeconomyhighhighestrecommendedПараметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC.

Тип параметра

string

Описание

Сумма выплаты

Тип параметра

string

Описание

Адрес кошелька, на который будет произведен вывод средств

Тип параметра

string

Описание

Код валюты для выплатыЕсли валюта является фиатной, то требуется параметр to_currency.

Описание

Код криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже

Тип параметра

string

Описание

Сетевой код блокчейнаНе требуется, если валюта/to_currency является криптовалютой и имеет только одну сеть, например BTC

Тип параметра

boolean

Описание

Определяет, откуда будет удерживаться комиссия за вывод средствtrue - с вашего балансаfalse - начиная с суммы выплаты, сумма выплаты будет уменьшена

Тип параметра

string
Доступные значения
- Binance- BinanceP2p- Exmo- Kucoin

Описание

Сервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца.

Тип параметра

stringmin: 4max: 11
Доступные значения
- recommended- economy- high- highest

Описание

Параметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC.

* - обязательный параметр

Пример запроса


curl https://api.heleket.com/v1/payout/calc \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json' \
-d '{
    "amount": "5",
    "address": "TDD97yguPESTpcrJMqU6h2ozZbibv4Vaqm",
    "currency": "USDT",
    "network": "TRON",
    "is_subtract": "1",
}'

Copy

Ответ

Параметры отклика

ИмяОписание
commissionСумма комиссии Heleket
merchant_amountСумма, подлежащая списанию с баланса продавца
payer_amountСумма, отправленная на адрес.

Описание

Сумма комиссии Heleket

Описание

Сумма, подлежащая списанию с баланса продавца

Описание

Сумма, отправленная на адрес.

Пример ответа


1{
2  "state": 0,
3  "result": {
4      "commission":"0.00000000",
5      "merchant_amount":"1.00000000",
6      "payout_amount":"1.0"
7  }
8}
9
Copy

Возможные ошибки

Ошибки проверки

код : 422

примеры ответов:


1{
2"state": 1,
3"errors": {
4"amount": ["validation.required"]
5}
6}
Copy

Если выплата заблокирована у вашего продавца или пользователя, вы получите это сообщение об ошибке. Это происходит, например, когда вы меняете свой пароль и выплаты блокируются на 24 часа.


1{
2"state": 1,
3"message": "You are forbidden"
4}
Copy

Если мы не поддерживаем код валюты, указанный вами в параметре валюты, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "The currency was not found"
4}
Copy

Если мы не сможем найти сервис для осуществления выплаты, вы получите это сообщение об ошибке. Вы должны убедиться, что криптовалюта поддерживается. Проверьте правильность заполения следующих значений: валюта, сеть, from_currency, to_currency:


1{
2"state": 1,
3"message": "The service was not found"
4}
Copy

Если сумма вывода слишком мала, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "The withdrawal amount is too small"
4}
Copy

Если у вас не будет активного торгового кошелька с криптовалютой для выплаты, вы получите эту ошибку:


1{
2"state": 1,
3"message": "Wallet not found"
4}
Copy

Если сумма выплаты, включая все комиссии, превышает ваш баланс, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Not enough funds"
4}
Copy

Если мы не найдем службу выплат в валюте, которая была передана в параметре to_currency, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Not found service to_currency"
4}
Copy

Если случайно что-то произойдет при конвертации в to_currency, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Error convert to_currency"
4}
Copy

Если сумма выплаты меньше минимальной поддерживаемой суммы для криптовалюты, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Minimum amount 0.5 USDT"
4}
Copy

Если сумма выплаты превышает максимальную поддерживаемую сумму для криптовалюты, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Maximum amount 10000000 USDT"
4}
Copy

Если у вас недостаточно средств для осуществления выплаты, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Not enough funds"
4}
Copy

Если у вас недостаточно средств для конвертации суммы выплаты из from_currency, вы получите это сообщение об ошибке:


1{
2"state": 1,
3"message": "Not enough balance for convert USDT to LTC"
4}
Copy

Если возникнут технические неполадки и выплата будет временно недоступна, вы получите это сообщение об ошибке


1{
2"state": 1,
3"message": "The terminal was not found"
4}
Copy

Внутренняя ошибка сервера

код : 500

примеры ответов:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}
Copy