Розрахунок суми виведення

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

Прохання

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

НазваТип параметраЗначення за замовчуваннямВизначення
amount*stringСума виплат
address*stringАдреса гаманця, до якого буде зроблено відкликання
currency*stringКод валюти для виплатиЯкщо валюта, якщо fiat, необхідний параметр to_currency .
to_currencyКод криптовалюти, в якому буде здійснена виплата. Він використовується, коли параметр currency є Fiat. Див. Приклади нижче
networkstringМережевий код BlockchainНе потрібно, коли валюта/to_currency є криптовалютою і має лише одну мережу, наприклад BTC
is_subtract*booleanВизначає, де буде віднято плата за зняттяПравда - від вашого балансупомилкове - від суми виплат, сума виплат буде зменшуватися
course_sourcestringНаявні значенняBinanceBinanceP2pExmoKucoinЦінність у налаштуваннях торговцяПослуга, з якої беруться валютні курси для перетворення в рахунку -фактуру.Параметр застосовується лише в тому випадку, якщо валюта є FIAT, інакше значення за замовчуванням взято з налаштувань продавця.
prioritystringmin: 4max: 11Наявні значенняrecommendedeconomyhighhighestrecommendedПараметр для вибору пріоритету виведення. Вартість комісії за зняття залежить від обраного параметра.Цей параметр застосовується лише у випадку використання мереж BTC, ETH, Polygon та BSC.

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

string

Визначення

Сума виплат

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

string

Визначення

Адреса гаманця, до якого буде зроблено відкликання

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

string

Визначення

Код валюти для виплатиЯкщо валюта, якщо fiat, необхідний параметр to_currency .

Визначення

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

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

string

Визначення

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

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

boolean

Визначення

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

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

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

Визначення

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

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

stringmin: 4max: 11
Наявні значення
- recommended- economy- high- highest

Визначення

Параметр для вибору пріоритету виведення. Вартість комісії за зняття залежить від обраного параметра.Цей параметр застосовується лише у випадку використання мереж BTC, ETH, Polygon та BSC.

* - обов'язковий параметр

Приклад запиту


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

Copy

Реакція

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

НазваВизначення
commissionСума комісії Heleket
merchant_amountСума, яку потрібно зняти з балансу продавця
payer_amountСума, яку було надіслано на адресу.

Визначення

Сума комісії Heleket

Визначення

Сума, яку потрібно зняти з балансу продавця

Визначення

Сума, яку було надіслано на адресу.

Приклад відповіді


1{
2  "state": 0,
3  "result": {
4      "commission":"0.00000000",
5      "merchant_amount":"1.00000000",
6      "payout_amount":"1.0"
7  }
8}
9
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

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