Створення виплат

post
https://api.cryptomus.com/v1/payout
Копіювати

Виплати через API здійснюються лише з залишків вашого бізнес -гаманця.

Виплати можна робити по -різному:

  1. Ви можете отримати виплату в певній криптовалюті, а виплата буде автоматично оброблена в цій конкретній криптовалюті. Для цього переконайтеся, що у вас є достатній баланс у цій конкретній валюті для покриття всіх пов'язаних зборів.
  2. Крім того, у вас є можливість вказати суму виплат у фіатній валюті. У цьому випадку сума буде автоматично перетворена на певну криптовалюту з наявного балансу. Наприклад, якщо ви вимагаєте виплат у розмірі 20 USD в LTC, еквівалентне значення буде вилучено з вашого балансу LTC. Важливо мати достатньо коштів у відповідній криптовалюті, щоб покрити всі відповідні збори.
  3. Інша можливість полягає у визначенні суми виплат у фіатній валюті, яка автоматично перетвориться на певну криптовалюту за допомогою вашого балансу USDT. Цей варіант особливо корисний, коли у вас увімкнено автоконвертування, оскільки кошти від ваших рахунків автоматично перетворюються на USDT. Наприклад, якщо ви хочете отримати виплату в 20 USD в LTC, але маєте залишок лише в доларах США, переконайтеся, що у вас є достатні кошти USDT для покриття всіх зборів.
  4. Крім того, ви можете вибрати, щоб вказати суму виплат у будь -якій криптовалюті ваших уподобань. Потім виплата буде автоматично оброблена в цій конкретній криптовалюті, використовуючи доступний баланс USDT. Важливо мати достатній баланс USDT для покриття всіх пов'язаних зборів.

Прохання

Параметри запиту

НазваТип параметраЗначення за замовчуваннямВизначення
amount*stringСума виплат
currency*stringКод валюти для виплатиЯкщо валюта є фіатною, параметр to_currency є обов'язковим.
order_id*stringmin:1max:100alpha_dashІдентифікатор замовлення у вашій системіПараметр повинен бути рядок, що складається з алфавітних символів, цифр, підкреслення та тире. Він не повинен містити жодних пробілів чи спеціальних символів. order_id повинен бути унікальним у виплаті торговцівКоли ми знайдемо існуючу виплату з order_ID , ми повертаємо його дані, нова виплата не буде створена.
address*stringАдреса гаманця, до якого буде зроблено відкликання
is_subtract*booleanВизначає, де буде віднято плата за зняттяПравда - від вашого балансупомилкове - від суми виплат, сума виплат буде зменшуватися
network*stringМережевий код BlockchainНе потрібно, коли валюта/to_currency є криптовалютою і має лише одну мережу, наприклад BTC
url_callbackURL, на який будуть надіслані webhooks із статусом виплат
to_currencyКод криптовалюти, в якому буде здійснена виплата. Він використовується, коли параметр currency є Fiat. Див. Приклади нижче
course_sourcestringНаявні значенняBinanceBinanceP2pExmoKucoinЦінність у налаштуваннях торговцяПослуга, з якої беруться валютні курси для перетворення в рахунку -фактуру.Параметр застосовується лише в тому випадку, якщо валюта є FIAT, інакше значення за замовчуванням взято з налаштувань продавця.
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

Визначення

Визначає, де буде віднято плата за зняттяПравда - від вашого балансупомилкове - від суми виплат, сума виплат буде зменшуватися

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

string

Визначення

Мережевий код BlockchainНе потрібно, коли валюта/to_currency є криптовалютою і має лише одну мережу, наприклад BTC

Визначення

URL, на який будуть надіслані webhooks із статусом виплат

Визначення

Код криптовалюти, в якому буде здійснена виплата. Він використовується, коли параметр currency є Fiat. Див. Приклади нижче

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

string
Наявні значення
- Binance- BinanceP2p- Exmo- Kucoin

Визначення

Послуга, з якої беруться валютні курси для перетворення в рахунку -фактуру.Параметр застосовується лише в тому випадку, якщо валюта є FIAT, інакше значення за замовчуванням взято з налаштувань продавця.

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

string

Визначення

Дозволяє автоматично перетворити суму з вилучення та використовувати баланс FROM_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",
}'
Копіювати

Реакція

Параметри відповіді

НазваВизначення
uuiduuid від виплат
amountСума виплати в currency
currencyКод валюти для виплати
networkКод блокчейн -мережі, в якій здійснюється платіж
addressАдреса гаманця, до якої здійснюється платіж
txidІдентифікатор транзакції в блокчейні
statusСтатус виплати Дивіться всі доступні статуси
is_finalЧи буде завершено виплатуПроцес виплат вважається доопрацьованим, коли він буде успішно виплачений або якщо він не вдалося. У разі невдачі виплати кошти будуть повернуті на ваш баланс, вимагаючи від вас знову ініціюйте процес виплат.
balanceРешта коштів на баланс торговця.
payer_currencyКод криптовалюти, в якому виплата буде фактично зроблена. Адреса виплат отримає валюту виплат.
payer_amountСума в payer_currency виплат.

Визначення

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}
Копіювати

Якщо у вас не вистачає коштів, щоб перетворити суму виплат від_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}
Копіювати