Tworzenie wypłaty

post
https://api.cryptomus.com/v1/payout
KOPIUJ

Wypłaty za pośrednictwem interfejsu API są wykonywane tylko z salda portfeli biznesowych.

Wypłaty można dokonywać na różne sposoby:

  1. Możesz otrzymać wypłatę w określonej kryptowalucie, a wypłata zostanie następnie automatycznie przetworzona w tej konkretnej kryptowalucie. Aby to zrobić, upewnij się, że masz wystarczającą równowagę w tej konkretnej walucie, aby pokryć wszystkie powiązane opłaty.
  2. Alternatywnie masz możliwość określenia kwoty wypłaty w walucie fiduat. W takim przypadku kwota zostanie automatycznie przekonwertowana na określoną kryptowalutę z dostępnego salda. Na przykład, jeśli poprosisz o wypłatę w wysokości 20 USD w LTC, równoważna wartość zostanie odjęta od salda LTC. Ważne jest, aby mieć wystarczającą liczbę środków w odpowiedniej kryptowalucie, aby pokryć wszystkie obowiązujące opłaty.
  3. Kolejną możliwością jest określenie kwoty wypłaty w walucie FIAT, która zostanie automatycznie przekonwertowana na określoną kryptowalutę za pomocą salda USDT. Ta opcja jest szczególnie przydatna po włączeniu Autoconvert, ponieważ środki z twoich faktur są automatycznie konwertowane na USDT. Na przykład, jeśli chcesz dokonać wypłaty w wysokości 20 USD w LTC, ale masz saldo tylko w USDT, upewnij się, że masz wystarczające środki USDT na pokrycie wszystkich opłat.
  4. Ponadto możesz określić kwotę wypłaty w dowolnej kryptowalucie swoich preferencji. Wypłata zostanie następnie automatycznie przetworzona w tej konkretnej kryptowalucie, wykorzystując dostępne saldo USDT. Ważne jest, aby mieć wystarczającą równowagę USDT, aby pokryć wszystkie powiązane opłaty.

Wniosek

Parametry zapytania

NazwaTyp parametruDomyślna wartośćDefinicja
amount*stringwysokość wypłaty
currency*stringKod waluty wypłatyJeśli waluta Jeśli Fiat, wymagany jest parametr to_currency .
order_id*stringmin:1max:100alpha_dashZamów identyfikator w twoim systemieParametr powinien być łańcuchem składającym się z znaków alfabetycznych, liczb, podkreśleń i dystansów. Nie powinien zawierać żadnych przestrzeni ani znaków specjalnych. order_id musi być unikalne w wypłatach handlowychKiedy znajdziemy istniejącą wypłatę z order_id, zwracamy jego szczegóły, nie zostanie utworzona nowa wypłata.
address*stringAdres portfela, do którego zostanie dokonane wycofanie
is_subtract*booleanOkreśla, gdzie zostanie odjęta opłata za wypłataPrawda - z twojej równowagiFałsz - od kwoty wypłaty kwota wypłaty zostanie zmniejszona
network*stringKod sieci BlockchainNie jest to wymagane, gdy waluta/to_currency jest kryptowalutą i ma tylko jedną sieć, na przykład BTC
url_callbackURL, na które zostaną wysłane hagithooks ze statusem wypłaty
to_currencyKod kryptowaluty, w którym zostanie wykonana wypłata. Jest używany, gdy parametr currency jest fiat. Zobacz przykłady poniżej
course_sourcestringDostępne wartościBinanceBinanceP2pExmoKucoinWartość z ustawień handlowcaUsługa, z której kursy walut są pobierane w celu konwersji we fakturze.Parametr jest stosowany tylko wtedy, gdy waluta jest fiat, w przeciwnym razie wartość domyślna jest pobierana z ustawień kupca.
from_currencystringnullPozwala automatycznie konwertować kwotę wypłaty i korzystać z bilansu od_urlenty. Dostępne jest tylko USDT.
prioritystringmin: 4max: 11Dostępne wartościrecommendedeconomyhighhighestrecommendedParametr wyboru priorytetu wypłaty. Koszt opłaty za wypłatę zależy od wybranego parametru.Ten parametr jest stosowany tylko w przypadku używania sieci BTC, ETH, Polygon i BSC.
memostringmin: 1max: 30Dodatkowy identyfikator TON, używany do określania konkretnego odbiorcy lub celu

Typ parametru

string

Definicja

wysokość wypłaty

Typ parametru

string

Definicja

Kod waluty wypłatyJeśli waluta Jeśli Fiat, wymagany jest parametr to_currency .

Typ parametru

stringmin:1max:100alpha_dash

Definicja

Zamów identyfikator w twoim systemieParametr powinien być łańcuchem składającym się z znaków alfabetycznych, liczb, podkreśleń i dystansów. Nie powinien zawierać żadnych przestrzeni ani znaków specjalnych. order_id musi być unikalne w wypłatach handlowychKiedy znajdziemy istniejącą wypłatę z order_id, zwracamy jego szczegóły, nie zostanie utworzona nowa wypłata.

Typ parametru

string

Definicja

Adres portfela, do którego zostanie dokonane wycofanie

Typ parametru

boolean

Definicja

Określa, gdzie zostanie odjęta opłata za wypłataPrawda - z twojej równowagiFałsz - od kwoty wypłaty kwota wypłaty zostanie zmniejszona

Typ parametru

string

Definicja

Kod sieci BlockchainNie jest to wymagane, gdy waluta/to_currency jest kryptowalutą i ma tylko jedną sieć, na przykład BTC

Definicja

URL, na które zostaną wysłane hagithooks ze statusem wypłaty

Definicja

Kod kryptowaluty, w którym zostanie wykonana wypłata. Jest używany, gdy parametr currency jest fiat. Zobacz przykłady poniżej

Typ parametru

string
Dostępne wartości
- Binance- BinanceP2p- Exmo- Kucoin

Definicja

Usługa, z której kursy walut są pobierane w celu konwersji we fakturze.Parametr jest stosowany tylko wtedy, gdy waluta jest fiat, w przeciwnym razie wartość domyślna jest pobierana z ustawień kupca.

Typ parametru

string

Definicja

Pozwala automatycznie konwertować kwotę wypłaty i korzystać z bilansu od_urlenty. Dostępne jest tylko USDT.

Typ parametru

stringmin: 4max: 11
Dostępne wartości
- recommended- economy- high- highest

Definicja

Parametr wyboru priorytetu wypłaty. Koszt opłaty za wypłatę zależy od wybranego parametru.Ten parametr jest stosowany tylko w przypadku używania sieci BTC, ETH, Polygon i BSC.

Typ parametru

stringmin: 1max: 30

Definicja

Dodatkowy identyfikator TON, używany do określania konkretnego odbiorcy lub celu

* - obowiązkowy parametr

Przykład żądania


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",
}'
KOPIUJ

Odpowiedź

Parametry odpowiedzi

NazwaDefinicja
uuiduuid wypłaty
amountKwota wypłaty w currency
currencyKod waluty wypłaty
networkKod sieci Blockchain, w której dokonywana jest płatność
addressAdres portfela, do którego dokonana jest płatność
txidID transakcji w blockchain
statusStatus wypłaty Zobacz wszystkie dostępne statusy
is_finalCzy wypłata jest sfinalizowanaProces wypłaty jest uważany za sfinalizowany po jego pomyślnym opłaceniu lub jeśli się nie udało. W przypadku awarii wypłaty fundusze zostaną zwrócone do twojego salda, wymagające ponownego zainicjowania procesu wypłaty.
balancePozostałe fundusze na równowagę handlowca.
payer_currencyKod kryptowaluty, w którym faktycznie zostanie wykonana wypłata. Adres wypłaty otrzyma walutę wypłat.
payer_amountKwota w Payer_Currency wypłaty.

Definicja

uuid wypłaty

Definicja

Kwota wypłaty w currency

Definicja

Kod waluty wypłaty

Definicja

Kod sieci Blockchain, w której dokonywana jest płatność

Definicja

Adres portfela, do którego dokonana jest płatność

Definicja

ID transakcji w blockchain

Definicja

Status wypłaty Zobacz wszystkie dostępne statusy

Definicja

Czy wypłata jest sfinalizowanaProces wypłaty jest uważany za sfinalizowany po jego pomyślnym opłaceniu lub jeśli się nie udało. W przypadku awarii wypłaty fundusze zostaną zwrócone do twojego salda, wymagające ponownego zainicjowania procesu wypłaty.

Definicja

Pozostałe fundusze na równowagę handlowca.

Definicja

Kod kryptowaluty, w którym faktycznie zostanie wykonana wypłata. Adres wypłaty otrzyma walutę wypłat.

Definicja

Kwota w Payer_Currency wypłaty.

Przykład odpowiedzi


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
KOPIUJ

Możliwe błędy

Błędy walidacji

kod : 422

Przykładowe odpowiedzi:


1{
2	"state": 1,
3	"errors": {
4		"amount": ["validation.required"]
5	}
6}
KOPIUJ

Jeśli wypłata zostanie zablokowana na sprzedawcy lub użytkowniku, otrzymasz ten komunikat o błędzie. Dzieje się tak na przykład po zmianie hasła, a wypłaty są blokowane na 24 godziny.


1{
2    "state": 1,
3    "message": "You are forbidden"
4}
KOPIUJ

Jeśli nie obsługujemy kodu walutowego podanego w parametrze waluty, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "The currency was not found"
4}
KOPIUJ

Jeśli nie będziemy w stanie znaleźć usługi wykonywania wypłaty, otrzymasz ten komunikat o błędzie. Musisz upewnić się, że kryptowaluta jest obsługiwana. Sprawdź poprawność wprowadzonych wartości w. Waluta, sieć, from_currency, to_currency:


1{
2    "state": 1,
3    "message": "The service was not found"
4}
KOPIUJ

Jeśli kwota wypłaty jest zbyt mała, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "The withdrawal amount is too small"
4}
KOPIUJ

Jeśli nie będziesz mieć aktywnego portfela handlowego z kryptowalutą wypłaty, otrzymasz ten błąd:


1{
2    "state": 1,
3    "message": "Wallet not found"
4}
KOPIUJ

Jeśli kwota wypłaty, w tym wszystkie prowizje, jest większa niż saldo, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}
KOPIUJ

Jeśli nie znajdziemy usługi wypłaty waluty, która została przekazana w parametrze do poziomu, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Not found service to_currency"
4}
KOPIUJ

Jeśli przypadkowo coś się wydarzy podczas konwersji na_purlenty, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Error convert to_currency"
4}
KOPIUJ

Jeśli kwota wypłaty jest mniejsza niż minimalna obsługiwana kwota kryptowaluty, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Minimum amount 0.5 USDT"
4}
KOPIUJ

Jeśli kwota wypłaty jest większa niż maksymalna obsługiwana kwota kryptowaluty, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Maximum amount 10000000 USDT"
4}
KOPIUJ

Jeśli nie masz wystarczającej liczby środków na wypłatę, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Not enough funds"
4}
KOPIUJ

Jeśli nie masz wystarczającej liczby środków na konwersję kwoty wypłaty z from_currency, otrzymasz ten komunikat o błędzie:


1{
2    "state": 1,
3    "message": "Not enough balance for convert USDT to LTC"
4}
KOPIUJ

Jeśli nastąpi praca techniczna, a wypłata jest tymczasowo niedostępna, otrzymasz ten komunikat o błędzie


1{
2    "state": 1,
3    "message": "The terminal was not found"
4}
KOPIUJ

Wewnętrzny błąd serwera

kod : 500

Przykładowe odpowiedzi:


1{
2	"message": "Server error, #1",
3	"code": 500,
4	"error": null
5}
KOPIUJ