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

post https://api.cryptomus.com/v1/payout Скопировать

Выплаты через 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_callback-URL, на который будут отправлены webhooks с состоянием выплат
to_currency-Код криптовалюты, в котором будет произведена выплата. Он используется, когда параметр currency является фиатным. Смотрите примеры ниже
course_sourcestringДоступные значения• Binance• BinanceP2p• Exmo• KucoinЗначение из настроек продавцаСервис, из которого берутся обменные курсы для пересчета в счете-фактуре.Параметр применяется только в том случае, если валюта является фиатной, в противном случае значение по умолчанию берется из настроек продавца.
from_currencystringnullПозволяет автоматически конвертировать сумму вывода и использовать баланс form_currency. Доступен только USDT.
prioritystringmin: 4max: 11Доступные значения• recommended• economy• high• highestrecommendedПараметр выбора приоритета вывода. Стоимость комиссии за вывод зависит от выбранного параметра.Этот параметр применяется только в случае использования сети BTC, ETH, Polygon и BSC.
memostringmin: 1max: 64-Дополнительный идентификатор для 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

Значение по умолчанию

Значение из настроек продавца
Доступные значения
- Binance- BinanceP2p- Exmo- Kucoin

Описание

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

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

string

Значение по умолчанию

null

Описание

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

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

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

Значение по умолчанию

recommended
Доступные значения
- recommended- economy- high- highest

Описание

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

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

stringmin: 1max: 64

Описание

Дополнительный идентификатор для 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"
}'
Скопировать

Ответ

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

ИмяТип параметраОписание
uuidstringuuid выплаты
amountstringСумма выплаты в currency
currencystringКод валюты для выплаты
networkstring|nullКод блокчейн-сети, в которой производится платеж
payer_currencystring|nullКод криптовалюты, в котором фактически будет произведена выплата. На адрес выплаты будет отправлена валюта выплаты.
payer_amountstring|nullСумма выплаты в payer_currency.
addressstringАдрес кошелька, на который производится платеж
txidstring|nullИдентификатор транзакции в блокчейне
statusstringСтатус выплаты
is_finalbooleanЗавершена ли выплатаПроцесс выплаты считается завершенным, как только он был успешно выплачен или если он завершился неудачей. В случае сбоя выплаты средства будут возвращены на ваш баланс, что потребует от вас повторного запуска процесса выплаты.
balancestring|nullОставшиеся средства на балансе продавца.
order_idstring|nullИдентификатор заказа в Вашей системе
commissionstring|nullСумма комиссии Cryptomus
merchant_amountstring|nullСумма, которая списывается с баланса продавца, включая все комиссии.
convertИнформация о валюте, в которую будет автоматически конвертирован платеж. Конвертация производится из payer_currency в USDTПрисутствует, если передан параметр from_currency.
convert.to_currencystring|nullКод валюты, в которую будет конвертирован платеж
convert.from_currencystringИз валюты
convert.commissionstringКомиссия за конвертацию
convert.ratestring|nullКоэффициент конверсии
convert.from_amountstring|nullСумма от

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

string

Описание

uuid выплаты

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

string

Описание

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

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

string

Описание

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

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

string|null

Описание

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

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

string|null

Описание

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

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

string|null

Описание

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

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

string

Описание

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

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

string|null

Описание

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

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

string

Описание

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

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

boolean

Описание

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

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

string|null

Описание

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

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

string|null

Описание

Идентификатор заказа в Вашей системе

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

string|null

Описание

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

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

string|null

Описание

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

Описание

Информация о валюте, в которую будет автоматически конвертирован платеж. Конвертация производится из payer_currency в USDTПрисутствует, если передан параметр from_currency.

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

string|null

Описание

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

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

string

Описание

Из валюты

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

string

Описание

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

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

string|null

Описание

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

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

string|null

Описание

Сумма от

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


1{
2    "state": 0,
3    "result": {
4        "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
5        "amount": "3",
6        "currency": "USDT",
7        "network": "TRON",
8        "payer_currency": "USDT",
9        "payer_amount": "3",
10        "address": "TJ...",
11        "txid": null,
12        "status": "process",
13        "is_final": false,
14        "balance": "129",
15        "order_id": "1",
16        "commission": null,
17        "merchant_amount": null
18    }
19}
20
Скопировать

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

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

код : 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}
Скопировать