Tworzenie wypłaty
Wypłaty za pośrednictwem interfejsu API są wykonywane tylko z salda portfeli biznesowych.
Wypłaty można dokonywać na różne sposoby:
- 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.
- 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.
- 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.
- 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
| Nazwa | Typ parametru | Domyślna wartość | Definicja |
|---|---|---|---|
| amount* | string | - | wysokość wypłaty |
| currency* | string | - | Kod waluty wypłatyJeśli waluta jest fiat, parametr to_currency jest wymagany. |
| order_id* | stringmin:1max:100alpha_dash | - | 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. |
| address* | string | - | Adres portfela, do którego zostanie dokonane wycofanie |
| is_subtract* | boolean | - | 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 |
| network* | string | - | Kod sieci BlockchainNie jest to wymagane, gdy waluta/to_currency jest kryptowalutą i ma tylko jedną sieć, na przykład BTC |
| url_callback | - | URL, na który będą wysyłane webhooks ze statusem wypłaty | |
| to_currency | - | Kod kryptowaluty, w którym zostanie wykonana wypłata. Jest używany, gdy parametr currency jest fiat. Zobacz przykłady poniżej | |
| course_source | stringDostępne wartości• Binance• BinanceP2p• Exmo• Kucoin | Wartość z ustawień handlowca | 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. |
| from_currency | string | null | Pozwala automatycznie konwertować kwotę wypłaty i korzystać z bilansu od_urlenty. Dostępne jest tylko USDT. |
| priority | stringmin: 4max: 11Dostępne wartości• recommended• economy• high• highest | recommended | 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. |
| memo | stringmin: 1max: 64 | - | Dodatkowy identyfikator TON, używany do określania konkretnego odbiorcy lub celu |
Typ parametru
stringDefinicja
wysokość wypłatyTyp parametru
stringDefinicja
Kod waluty wypłatyJeśli waluta jest fiat, parametr to_currency jest wymagany.Typ parametru
stringmin:1max:100alpha_dashDefinicja
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
stringDefinicja
Adres portfela, do którego zostanie dokonane wycofanieTyp parametru
booleanDefinicja
Określa, gdzie zostanie odjęta opłata za wypłataPrawda - z twojej równowagiFałsz - od kwoty wypłaty kwota wypłaty zostanie zmniejszonaTyp parametru
stringDefinicja
Kod sieci BlockchainNie jest to wymagane, gdy waluta/to_currency jest kryptowalutą i ma tylko jedną sieć, na przykład BTCDefinicja
URL, na który będą wysyłane webhooks ze statusem wypłatyDefinicja
Kod kryptowaluty, w którym zostanie wykonana wypłata. Jest używany, gdy parametr currency jest fiat. Zobacz przykłady poniżejTyp parametru
string
Dostępne wartości- Binance- BinanceP2p- Exmo- KucoinDomyślna wartość
Wartość z ustawień handlowca
Dostępne wartości- Binance- BinanceP2p- Exmo- KucoinDefinicja
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
stringDomyślna wartość
nullDefinicja
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- highestDomyślna wartość
recommended
Dostępne wartości- recommended- economy- high- highestDefinicja
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: 64Definicja
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"
}'
KopiaOdpowiedź
Parametry odpowiedzi
| Nazwa | Typ parametru | Definicja |
|---|---|---|
| uuid | string | uuid wypłaty |
| amount | string | Kwota wypłaty w currency |
| currency | string | Kod waluty wypłaty |
| network | string|null | Kod sieci Blockchain, w której dokonywana jest płatność |
| payer_currency | string|null | Kod kryptowaluty, w którym faktycznie zostanie wykonana wypłata. Adres wypłaty otrzyma walutę wypłat. |
| payer_amount | string|null | Kwota w Payer_Currency wypłaty. |
| address | string | Adres portfela, do którego dokonana jest płatność |
| txid | string|null | ID transakcji w blockchain |
| status | string | Status wypłaty Zobacz wszystkie dostępne statusy |
| is_final | boolean | 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. |
| balance | string|null | Pozostałe fundusze na równowagę handlowca. |
| order_id | string|null | Zamów identyfikator w twoim systemie |
| commission | string|null | Kwota Komisji Cryptomus |
| merchant_amount | string|null | Kwota, która jest pobierana z salda sprzedawcy, w tym wszystkie prowizje. |
| convert | Informacje o walucie, do której płatność zostanie automatycznie przekonwertowana. Konwersja odbywa się z płatnika_currency do USDTObecny, jeśli przekazano from_currency | |
| convert.to_currency | string|null | Kod waluty, do którego płatność zostanie przekonwertowana |
| convert.from_currency | string | Z waluty |
| convert.commission | string | Opłata za konwersję |
| convert.rate | string|null | Współczynnik konwersji |
| convert.from_amount | string|null | Kwota od |
Typ parametru
stringDefinicja
uuid wypłatyTyp parametru
stringDefinicja
Kwota wypłaty w currencyTyp parametru
stringDefinicja
Kod waluty wypłatyTyp parametru
string|nullDefinicja
Kod sieci Blockchain, w której dokonywana jest płatnośćTyp parametru
string|nullDefinicja
Kod kryptowaluty, w którym faktycznie zostanie wykonana wypłata. Adres wypłaty otrzyma walutę wypłat.Typ parametru
string|nullDefinicja
Kwota w Payer_Currency wypłaty.Typ parametru
stringDefinicja
Adres portfela, do którego dokonana jest płatnośćTyp parametru
string|nullDefinicja
ID transakcji w blockchainTyp parametru
stringTyp parametru
booleanDefinicja
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.Typ parametru
string|nullDefinicja
Pozostałe fundusze na równowagę handlowca.Typ parametru
string|nullDefinicja
Zamów identyfikator w twoim systemieTyp parametru
string|nullDefinicja
Kwota Komisji CryptomusTyp parametru
string|nullDefinicja
Kwota, która jest pobierana z salda sprzedawcy, w tym wszystkie prowizje.Definicja
Informacje o walucie, do której płatność zostanie automatycznie przekonwertowana. Konwersja odbywa się z płatnika_currency do USDTObecny, jeśli przekazano from_currencyTyp parametru
string|nullDefinicja
Kod waluty, do którego płatność zostanie przekonwertowanaTyp parametru
stringDefinicja
Z walutyTyp parametru
stringDefinicja
Opłata za konwersjęTyp parametru
string|nullDefinicja
Współczynnik konwersjiTyp parametru
string|nullDefinicja
Kwota od
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 "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}
20KopiaMożliwe błędy
Błędy walidacji
kod : 422
przykładowe odpowiedzi:
1{
2 "state": 1,
3 "errors": {
4 "amount": ["validation.required"]
5 }
6}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeśli nie znajdziemy usługi wypłat dla waluty, która została przekazana w parametrze to_currency, otrzymasz tę wiadomość o błędzie:
1{
2 "state": 1,
3 "message": "Not found service to_currency"
4}KopiaJeśli przypadkowo coś się stanie podczas konwersji na to_currency, otrzymasz tę wiadomość o błędzie:
1{
2 "state": 1,
3 "message": "Error convert to_currency"
4}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaJeś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}KopiaWewnętrzny błąd serwera
kod : 500
przykładowe odpowiedzi:
1{
2 "message": "Server error, #1",
3 "code": 500,
4 "error": null
5}Kopia