支払いを作成します

post
https://api.cryptomus.com/v1/payout
コピー

APIを介した支払いは、ビジネスウォレットのバランスからのみ行われます。

支払いはさまざまな方法で行うことができます：

  1. 特定の暗号通貨でペイアウトを受信することを選択できます。その後、その特定の暗号通貨で支払いが自動的に処理されます。そうするために、関連するすべての料金をカバーするために、その特定の通貨に十分な残高があることを確認してください。
  2. または、フィアット通貨で支払い額を指定するオプションがあります。この場合、量は利用可能なバランスから特定の暗号通貨に自動的に変換されます。たとえば、LTCで20米ドルの支払いをリクエストすると、同等の値はLTC残高から差し引かれます。適用されるすべての料金をカバーするために、対応する暗号通貨に十分な資金を持っていることが重要です。
  3. 別の可能性は、Fiat通貨の支払い額を指定することです。これは、USDTバランスを使用して特定の暗号通貨に自動的に変換されます。このオプションは、請求書からの資金がUSDTに自動的に変換されるため、AutoConvertを有効にする場合に特に便利です。たとえば、LTCで20米ドルの支払いを行いたいが、USDTでのみ残高がある場合は、すべての料金をカバーするのに十分なUSDTファンドがあることを確認してください。
  4. さらに、好みの暗号通貨で支払い額を指定することを選択できます。その後、利用可能なUSDTバランスを利用して、その特定の暗号通貨で支払いが自動的に処理されます。関連するすべての料金をカバーするのに十分なUSDT残高を持つことが重要です。

リクエスト

クエリパラメーター

名前パラメータータイプデフォルト値意味
amount*string支払い額
currency*string支払いの通貨コード通貨の場合、 to_currencyパラメーターが必要です。
order_id*stringmin:1max:100alpha_dashシステムでIDを注文しますパラメーターは、アルファベット文字、数字、アンダースコア、およびダッシュで構成される文字列である必要があります。スペースや特殊文字を含めるべきではありません。 order_id は、商人の支払いの中で一意でなければなりません order_id を使用して既存のペイアウトを見つけると、詳細を返します。新しい支払いは作成されません。
address*string撤退が行われるウォレットのアドレス
is_subtract*boolean引き出し料金が控除される場所を定義します真 -あなたのバランスからfalse-支払い額から、支払い額は減少します
network*stringブロックチェーンネットワークコード currency/to_currency が暗号通貨であり、たとえばBTCなどのネットワークが1つしかない場合は必須ではありません
url_callbackペイアウトステータスのWebhookが送信されるURL
to_currency支払いが行われる暗号通貨コード。 currencyパラメーターがfiatの場合に使用されます。以下の例を参照してください
course_sourcestring利用可能な値• Binance• BinanceP2p• Exmo• Kucoin商人の設定からの価値請求書での変換のために為替レートが取られるサービス。パラメーターは、通貨がフィアットの場合にのみ適用されます。そうしないと、デフォルト値は商人の設定から取得されます。
from_currencystringnull引き出し額を自動的に変換し、from_currencyバランスを使用できます。 USDTのみが利用可能です。
prioritystringmin: 4max: 11利用可能な値• recommended• economy• high• highestrecommended出金の優先順位を選択するためのパラメータ。出金手数料は選択したパラメータによって異なります。このパラメーターは、BTC、ETH、ポリゴン、およびBSCネットワークを使用した場合にのみ適用されます。
memostringmin: 1max: 30特定の受信者またはターゲットを指定するために使用されるトンの追加識別子

パラメータータイプ

string

意味

支払い額

パラメータータイプ

string

意味

支払いの通貨コード通貨の場合、 to_currencyパラメーターが必要です。

パラメータータイプ

stringmin:1max:100alpha_dash

意味

システムでIDを注文しますパラメーターは、アルファベット文字、数字、アンダースコア、およびダッシュで構成される文字列である必要があります。スペースや特殊文字を含めるべきではありません。 order_id は、商人の支払いの中で一意でなければなりません order_id を使用して既存のペイアウトを見つけると、詳細を返します。新しい支払いは作成されません。

パラメータータイプ

string

意味

撤退が行われるウォレットのアドレス

パラメータータイプ

boolean

意味

引き出し料金が控除される場所を定義します真 -あなたのバランスからfalse-支払い額から、支払い額は減少します

パラメータータイプ

string

意味

ブロックチェーンネットワークコード currency/to_currency が暗号通貨であり、たとえばBTCなどのネットワークが1つしかない場合は必須ではありません

意味

ペイアウトステータスのWebhookが送信されるURL

意味

支払いが行われる暗号通貨コード。 currencyパラメーターがfiatの場合に使用されます。以下の例を参照してください

パラメータータイプ

string
利用可能な値- Binance- BinanceP2p- Exmo- Kucoin

意味

請求書での変換のために為替レートが取られるサービス。パラメーターは、通貨がフィアットの場合にのみ適用されます。そうしないと、デフォルト値は商人の設定から取得されます。

パラメータータイプ

string

意味

引き出し額を自動的に変換し、from_currencyバランスを使用できます。 USDTのみが利用可能です。

パラメータータイプ

stringmin: 4max: 11
利用可能な値- recommended- economy- high- highest

意味

出金の優先順位を選択するためのパラメータ。出金手数料は選択したパラメータによって異なります。このパラメーターは、BTC、ETH、ポリゴン、およびBSCネットワークを使用した場合にのみ適用されます。

パラメータータイプ

stringmin: 1max: 30

意味

特定の受信者またはターゲットを指定するために使用されるトンの追加識別子

* - 必須パラメーター

リクエスト例


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",
}'
コピー

応答

応答パラメーター

名前意味
uuid支払いのuuid
amount通貨での支払いcurrency
currency支払いの通貨コード
network支払いが行われるブロックチェーンネットワークのコード
address支払いが行われるウォレットの住所
txidブロックチェーンのトランザクションID
status支払いステータス 利用可能なすべてのステータスを参照してください
is_final支払いが確定されているかどうか支払いプロセスは、正常に支払われた場合、または失敗した場合に完了したと見なされます。支払いの失敗が発生した場合、資金は残高に返還され、ペイアウトプロセスを再度開始する必要があります。
balance商人の残りの残りの資金。
payer_currency支払いが実際に行われる暗号通貨コード。ペイアウトアドレスは、支払い通貨を受け取ります。
payer_amount支払いの payer_currency の金額。

意味

支払いのuuid

意味

通貨での支払いcurrency

意味

支払いの通貨コード

意味

支払いが行われるブロックチェーンネットワークのコード

意味

支払いが行われるウォレットの住所

意味

ブロックチェーンのトランザクションID

意味

支払いステータス 利用可能なすべてのステータスを参照してください

意味

支払いが確定されているかどうか支払いプロセスは、正常に支払われた場合、または失敗した場合に完了したと見なされます。支払いの失敗が発生した場合、資金は残高に返還され、ペイアウトプロセスを再度開始する必要があります。

意味

商人の残りの残りの資金。

意味

支払いが実際に行われる暗号通貨コード。ペイアウトアドレスは、支払い通貨を受け取ります。

意味

支払いの 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}
コピー

from_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}
コピー