Создание выплаты

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

Выплаты через API производятся только с балансов ваших бизнес-кошельков.

Выплаты могут быть произведены различными способами:

  1. Вы можете выбрать получение выплаты в определенной криптовалюте, и затем выплата будет автоматически обработана в этой конкретной криптовалюте. Для этого убедитесь, что у вас есть достаточный баланс в этой конкретной валюте для покрытия всех связанных с этим сборов.
  2. В качестве альтернативы, у вас есть возможность указать сумму выплаты в фиатной валюте. В этом случае сумма будет автоматически конвертирована в определенную криптовалюту с вашего доступного баланса. Например, если вы запросите выплату в размере 20 долларов США в LTC, эквивалентная сумма будет вычтена из вашего баланса LTC. Важно иметь достаточно средств в соответствующей криптовалюте, чтобы покрыть все применимые сборы.
  3. Другая возможность - указать сумму выплаты в фиатной валюте, которая будет автоматически конвертирована в определенную криптовалюту с использованием вашего баланса USDT. Эта опция особенно полезна, если у вас включена автоконвертация, поскольку средства из ваших счетов автоматически конвертируются в USDT. Например, если вы хотите произвести выплату в размере 20 долларов США в LTC, но у вас есть баланс только в USDT, убедитесь, что у вас достаточно средств в USDT для покрытия всех сборов.
  4. Кроме того, вы можете указать сумму выплаты в любой криптовалюте по вашему выбору. Затем выплата будет автоматически обработана в этой конкретной криптовалюте с использованием вашего доступного баланса USDT. Крайне важно иметь достаточный баланс в долларах США, чтобы покрыть все связанные с этим сборы.

Запрос

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

ИмяТип параметраЗначение по умолчаниюОписание
amount*stringСумма выплаты
currency*stringКод валюты для выплатыЕсли валюта является фиатной, то требуется параметр to_currency.
order_id*stringmin:1max:100alpha_dashИдентификатор заказа в Вашей системеПараметр должен представлять собой строку, состоящую из буквенных символов, цифр, подчеркиваний и тире. Он не должен содержать никаких пробелов или специальных символов.order_id должен быть уникальным в рамках торговых выплатКогда мы находим существующую выплату с order_id, мы возвращаем ее данные, новая выплата создана не будет.
address*stringАдрес кошелька, на который будет произведен вывод средств
is_subtract*booleanОпределяет, откуда будет удерживаться комиссия за вывод средствtrue - с вашего балансаfalse - начиная с суммы выплаты, сумма выплаты будет уменьшена
network*stringСетевой код блокчейнаНе требуется, если валюта/to_currency является криптовалютой и имеет только одну сеть, например BTC
url_callbackURL, на который будут отправлены webhooks с состоянием выплат
to_currencyКод криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже
course_sourcestringДоступные значенияBinanceBinanceP2pExmoKucoinЗначение из настроек продавцаСервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца.
from_currencystringnullПозволяет автоматически конвертировать сумму вывода и использовать баланс from_currency. Доступен только USDT.
prioritystringmin: 4max: 11Доступные значенияrecommendedeconomyhighhighestrecommendedПараметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC.
memostringmin: 1max: 30Дополнительный идентификатор для TON, который используется для указания конкретного адресата или цели

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

string

Описание

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

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

string

Описание

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

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

stringmin:1max:100alpha_dash

Описание

Идентификатор заказа в Вашей системеПараметр должен представлять собой строку, состоящую из буквенных символов, цифр, подчеркиваний и тире. Он не должен содержать никаких пробелов или специальных символов.order_id должен быть уникальным в рамках торговых выплатКогда мы находим существующую выплату с order_id, мы возвращаем ее данные, новая выплата создана не будет.

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

string

Описание

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

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

boolean

Описание

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

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

string

Описание

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

Описание

URL, на который будут отправлены webhooks с состоянием выплат

Описание

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

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

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

Описание

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

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

string

Описание

Позволяет автоматически конвертировать сумму вывода и использовать баланс from_currency. Доступен только USDT.

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

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

Описание

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

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

stringmin: 1max: 30

Описание

Дополнительный идентификатор для TON, который используется для указания конкретного адресата или цели

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

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


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

Ответ

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

ИмяОписание
uuiduuid выплаты
amountСумма выплаты в currency
currencyКод валюты для выплаты
networkКод блокчейн-сети, в которой производится платеж
addressАдрес кошелька, на который производится платеж
txidИдентификатор транзакции в блокчейне
statusСтатус выплаты Просмотреть все доступные статусы
is_finalЗавершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.
balanceОставшиеся средства на балансе продавца.
payer_currencyКод криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.
payer_amountСумма выплаты в валюте плательщика
commissionКомиссия сервиса
merchant_amountСумма, списанная с баланса, с учетом всех комиссий
convertИнформация конвертации. Конвертация производится из from_currency в to_currency.Поле convert не будет существовать, если вы не передали from_currency, или он совпадает с to_currency Структура

Описание

uuid выплаты

Описание

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

Описание

Код валюты для выплаты

Описание

Код блокчейн-сети, в которой производится платеж

Описание

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

Описание

Идентификатор транзакции в блокчейне

Описание

Статус выплаты Просмотреть все доступные статусы

Описание

Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.

Описание

Оставшиеся средства на балансе продавца.

Описание

Код криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.

Описание

Сумма выплаты в валюте плательщика

Описание

Комиссия сервиса

Описание

Сумма, списанная с баланса, с учетом всех комиссий

Описание

Информация конвертации. Конвертация производится из from_currency в to_currency.Поле convert не будет существовать, если вы не передали from_currency, или он совпадает с to_currency Структура

Структура convert

ИмяОписание
to_currencyКод валюты, в которую будет конвертирован платеж
from_currencyВалюта, из которой конвертируется платеж
commissionКомиссия за конвертацию
rateКоэффициент конверсии
from_amountСумма конвертации в from_currency, которая была списана с баланса, с вычетом всех комиссионных.

Описание

Код валюты, в которую будет конвертирован платеж

Описание

Валюта, из которой конвертируется платеж

Описание

Комиссия за конвертацию

Описание

Коэффициент конверсии

Описание

Сумма конвертации в from_currency, которая была списана с баланса, с вычетом всех комиссионных.

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


1{
2    "state": 0,
3    "result": {
4        "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5        "amount": "3",
6        "currency": "USDT",
7        "commission": "0.001",
8        "merchant_amount": "3.001"
9        "network": "TRON",
10        "address": "TJ...",
11        "txid": null,
12        "status": "process",
13        "is_final": false,
14        "balance": 129,
15        "payer_currency": "USD",
16        "payer_amount": 3
17    }
18}
19
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