Создание выплаты
Выплаты через API производятся только с балансов ваших бизнес-кошельков.
Выплаты могут быть произведены различными способами:
- Вы можете выбрать получение выплаты в определенной криптовалюте, и затем выплата будет автоматически обработана в этой конкретной криптовалюте. Для этого убедитесь, что у вас есть достаточный баланс в этой конкретной валюте для покрытия всех связанных с этим сборов.
- В качестве альтернативы, у вас есть возможность указать сумму выплаты в фиатной валюте. В этом случае сумма будет автоматически конвертирована в определенную криптовалюту с вашего доступного баланса. Например, если вы запросите выплату в размере 20 долларов США в LTC, эквивалентная сумма будет вычтена из вашего баланса LTC. Важно иметь достаточно средств в соответствующей криптовалюте, чтобы покрыть все применимые сборы.
- Другая возможность - указать сумму выплаты в фиатной валюте, которая будет автоматически конвертирована в определенную криптовалюту с использованием вашего баланса USDT. Эта опция особенно полезна, если у вас включена автоконвертация, поскольку средства из ваших счетов автоматически конвертируются в USDT. Например, если вы хотите произвести выплату в размере 20 долларов США в LTC, но у вас есть баланс только в USDT, убедитесь, что у вас достаточно средств в USDT для покрытия всех сборов.
- Кроме того, вы можете указать сумму выплаты в любой криптовалюте по вашему выбору. Затем выплата будет автоматически обработана в этой конкретной криптовалюте с использованием вашего доступного баланса 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 | Сетевой код блокчейнаНе требуется, если currency/to_currency является криптовалютой и имеет только одну сеть, например BTC | |
url_callback | URL, на который будут отправлены веб-ссылки со статусом выплаты | ||
to_currency | Код криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже | ||
course_source | stringДоступные значения• Binance• BinanceP2p• Exmo• Kucoin | Значение из настроек продавца | Сервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца. |
from_currency | string | null | Позволяет автоматически конвертировать сумму вывода и использовать баланс form_currency. Доступен только USDT. |
priority | stringmin: 4max: 11Доступные значения• recommended• economy• high• highest | recommended | Параметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC. |
memo | stringmin: 1max: 30 | Дополнительный идентификатор для TON, который используется для указания конкретного адресата или цели |
Тип параметра
stringОписание
Сумма выплатыТип параметра
stringОписание
Код валюты для выплатыЕсли валюта является фиатной, то требуется параметр to_currency.Тип параметра
stringmin:1max:100alpha_dashОписание
Идентификатор заказа в Вашей системеПараметр должен представлять собой строку, состоящую из буквенных символов, цифр, подчеркиваний и тире. Он не должен содержать никаких пробелов или специальных символов.order_id должен быть уникальным в рамках торговых выплатКогда мы находим существующую выплату с order_id, мы возвращаем ее данные, новая выплата создана не будет.Тип параметра
stringОписание
Адрес кошелька, на который будет произведен вывод средствТип параметра
booleanОписание
Определяет, откуда будет удерживаться комиссия за вывод средствtrue - с вашего балансаfalse - начиная с суммы выплаты, сумма выплаты будет уменьшенаТип параметра
stringОписание
Сетевой код блокчейнаНе требуется, если currency/to_currency является криптовалютой и имеет только одну сеть, например BTCОписание
URL, на который будут отправлены веб-ссылки со статусом выплатыОписание
Код криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры нижеТип параметра
string
Доступные значения- Binance- BinanceP2p- Exmo- KucoinОписание
Сервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца.Тип параметра
stringОписание
Позволяет автоматически конвертировать сумму вывода и использовать баланс form_currency. Доступен только USDT.Тип параметра
stringmin: 4max: 11
Доступные значения- recommended- economy- high- highestОписание
Параметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC.Тип параметра
stringmin: 1max: 30Описание
Дополнительный идентификатор для TON, который используется для указания конкретного адресата или цели
* - обязательный параметр
Пример запроса
curl https://api.cryptomus.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",
}'
копироватьОтвет
Параметры отклика
Описание
uuid выплатыОписание
Сумма выплаты в currencyОписание
Код валюты для выплатыОписание
Код блокчейн-сети, в которой производится платежОписание
Адрес кошелька, на который производится платежОписание
Идентификатор транзакции в блокчейнеОписание
Статус выплатыОписание
Завершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.Описание
Оставшиеся средства на балансе продавца.Описание
Код криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.Описание
Сумма выплаты в payer_currency.
Пример ответа
1{
2 "state": 0,
3 "result": {
4 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5 "amount": "3",
6 "currency": "USDT",
7 "network": "TRON",
8 "address": "TJ...",
9 "txid": null,
10 "status": "process",
11 "is_final": false,
12 "balance": 129,
13 "payer_currency": "USD",
14 "payer_amount": 3
15 }
16}
17
копироватьВозможные ошибки
Ошибки проверки
код : 422
Примеры ответов:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}
копироватьЕсли выплата заблокирована у вашего продавца или пользователя, вы получите это сообщение об ошибке. Это происходит, например, когда вы меняете свой пароль и выплаты блокируются на 24 часа.
1{
2 "state": 1,
3 "message": "You are forbidden"
4}
копироватьЕсли мы не поддерживаем код валюты, указанный вами в параметре валюты, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "The currency was not found"
4}
копироватьЕсли мы не сможем найти сервис для осуществления выплаты, вы получите это сообщение об ошибке. Вы должны убедиться, что криптовалюта поддерживается. Проверьте правильность введенных значений в. валюта, сеть, from_currency, to_currency:
1{
2 "state": 1,
3 "message": "The service was not found"
4}
копироватьЕсли сумма вывода слишком мала, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "The withdrawal amount is too small"
4}
копироватьЕсли у вас не будет активного торгового кошелька с криптовалютой для выплаты, вы получите эту ошибку:
1{
2 "state": 1,
3 "message": "Wallet not found"
4}
копироватьЕсли сумма выплаты, включая все комиссии, превышает ваш баланс, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
копироватьЕсли мы не найдем службу выплат в валюте, которая была передана в параметре to_currency, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}
копироватьЕсли случайно что-то произойдет при конвертации в to_currency, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}
копироватьЕсли сумма выплаты меньше минимальной поддерживаемой суммы для криптовалюты, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Minimum amount 0.5 USDT"
4}
копироватьЕсли сумма выплаты превышает максимальную поддерживаемую сумму для криптовалюты, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Maximum amount 10000000 USDT"
4}
копироватьЕсли у вас недостаточно средств для осуществления выплаты, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Not enough funds"
4}
копироватьЕсли у вас недостаточно средств для конвертации суммы выплаты из from_currency, вы получите это сообщение об ошибке:
1{
2 "state": 1,
3 "message": "Not enough balance for convert USDT to LTC"
4}
копироватьЕсли возникнут технические неполадки и выплата будет временно недоступна, вы получите это сообщение об ошибке
1{
2 "state": 1,
3 "message": "The terminal was not found"
4}
копироватьВнутренняя ошибка сервера
код : 500
Примеры ответов:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}
копировать