Виплати через API здійснюються лише з залишків вашого бізнес -гаманця.
Виплати можна робити по -різному:
- Ви можете отримати виплату в певній криптовалюті, а виплата буде автоматично оброблена в цій конкретній криптовалюті. Для цього переконайтеся, що у вас є достатній баланс у цій конкретній валюті для покриття всіх пов'язаних зборів.
- Крім того, у вас є можливість вказати суму виплат у фіатній валюті. У цьому випадку сума буде автоматично перетворена на певну криптовалюту з наявного балансу. Наприклад, якщо ви вимагаєте виплат у розмірі 20 USD в LTC, еквівалентне значення буде вилучено з вашого балансу LTC. Важливо мати достатньо коштів у відповідній криптовалюті, щоб покрити всі відповідні збори.
- Інша можливість полягає у визначенні суми виплат у фіатній валюті, яка автоматично перетвориться на певну криптовалюту за допомогою вашого балансу USDT. Цей варіант особливо корисний, коли у вас увімкнено автоконвертування, оскільки кошти від ваших рахунків автоматично перетворюються на USDT. Наприклад, якщо ви хочете отримати виплату в 20 USD в LTC, але маєте залишок лише в доларах США, переконайтеся, що у вас є достатні кошти USDT для покриття всіх зборів.
- Крім того, ви можете вибрати, щоб вказати суму виплат у будь -якій криптовалюті ваших уподобань. Потім виплата буде автоматично оброблена в цій конкретній криптовалюті, використовуючи доступний баланс USDT. Важливо мати достатній баланс USDT для покриття всіх пов'язаних зборів.
Прохання
Параметри запиту
| Назва | Тип параметра | Значення за замовчуванням | Визначення |
|---|---|---|---|
| amount* | string | Сума виплат | |
| currency* | string | Код валюти для виплатиЯкщо валюта, якщо fiat, необхідний параметр to_currency . | |
| order_id* | stringmin:1max:100alpha_dash | Ідентифікатор замовлення у вашій системіПараметр повинен бути рядок, що складається з алфавітних символів, цифр, підкреслення та тире. Він не повинен містити жодних пробілів чи спеціальних символів. order_id повинен бути унікальним у виплаті торговцівКоли ми знайдемо існуючу виплату з order_ID , ми повертаємо його дані, нова виплата не буде створена. | |
| address* | string | Адреса гаманця, до якого буде зроблено відкликання | |
| is_subtract* | boolean | Визначає, де буде віднято плата за зняттяПравда - від вашого балансупомилкове - від суми виплат, сума виплат буде зменшуватися | |
| network* | string | Мережевий код BlockchainНе потрібно, коли валюта/to_currency є криптовалютою і має лише одну мережу, наприклад BTC | |
| url_callback | URL, на який будуть надіслані webhooks із статусом виплат | ||
| to_currency | Код криптовалюти, в якому буде здійснена виплата. Він використовується, коли параметр currency є Fiat. Див. Приклади нижче | ||
| course_source | stringНаявні значення• Binance• BinanceP2p• Exmo• Kucoin | Цінність у налаштуваннях торговця | Послуга, з якої беруться валютні курси для перетворення в рахунку -фактуру.Параметр застосовується лише в тому випадку, якщо валюта є FIAT, інакше значення за замовчуванням взято з налаштувань продавця. |
| from_currency | string | null | Дозволяє автоматично перетворити суму з вилучення та використовувати баланс FROM_CURRENCY. Доступний лише USDT. |
| priority | stringmin: 4max: 11Наявні значення• recommended• economy• high• highest | recommended | Параметр для вибору пріоритету виведення. Вартість комісії за зняття залежить від обраного параметра.Цей параметр застосовується лише у випадку використання мереж BTC, ETH, Polygon та BSC. |
| memo | stringmin: 1max: 30 | Додатковий ідентифікатор TON, який використовується для визначення певного одержувача або цілі |
Тип параметра
stringВизначення
Сума виплатТип параметра
stringВизначення
Код валюти для виплатиЯкщо валюта, якщо fiat, необхідний параметр 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.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Реакція
Параметри відповіді
| Назва | Визначення |
|---|---|
| uuid | uuid від виплат |
| 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 | Сума, конвертована у валюту_фрі, яка була списана з балансу, за вирахуванням усіх комісій. |
Визначення
Код валюти, в яку буде конвертовано платіжВизначення
Валюта, з якої конвертується платіжВизначення
Комісія за конвертаціюВизначення
Коефіцієнт конверсіїВизначення
Сума, конвертована у валюту_фрі, яка була списана з балансу, за вирахуванням усіх комісій.
Приклад відповіді
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}
19CopyМожливі помилки
Помилки перевірки
кодування : 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Якщо у вас не вистачає коштів, щоб перетворити суму виплат від_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