Запрос
Параметры запроса
| Имя | Тип параметра | Значение по умолчанию | Описание |
|---|---|---|---|
| amount* | string | Сумма выплаты | |
| address* | string | Адрес кошелька, на который будет произведен вывод средств | |
| currency* | string | Код валюты для выплатыЕсли валюта является фиатной, то требуется параметр to_currency. | |
| to_currency | Код криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже | ||
| network | string | Сетевой код блокчейнаНе требуется, если валюта/to_currency является криптовалютой и имеет только одну сеть, например BTC | |
| is_subtract* | boolean | Определяет, откуда будет удерживаться комиссия за вывод средствtrue - с вашего балансаfalse - начиная с суммы выплаты, сумма выплаты будет уменьшена | |
| course_source | stringДоступные значения• Binance• BinanceP2p• Exmo• Kucoin | Значение из настроек продавца | Сервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца. |
| priority | stringmin: 4max: 11Доступные значения• recommended• economy• high• highest | recommended | Параметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети 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}
9CopyВозможные ошибки
Ошибки проверки
код : 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