建立付款
post
https://api.cryptomus.com/v1/payout
透過 API 進行的付款僅來自您的商業錢包餘額。
付款方式有多種：
- 您可以選擇以特定加密貨幣接收付款，付款將自動以該特定加密貨幣處理。為此，請確保您擁有足夠的該特定貨幣餘額來支付所有相關費用。
- 或者，您可以選擇以法定貨幣指定支付金額。在這種情況下，該金額將自動從您的可用餘額轉換為特定的加密貨幣。例如，如果您要求以萊特幣 (LTC) 支付 20 美元，則等值金額將從您的萊特幣餘額中扣除。請務必持有足夠的相應加密貨幣資金以支付所有適用費用。
- 另一種選擇是指定法定貨幣的支付金額，該金額將使用您的 USDT 餘額自動轉換為特定的加密貨幣。此選項在您啟用自動轉換功能時尤其有用，因為發票中的資金將自動轉換為 USDT。例如，如果您希望以 LTC 支付 20 美元，但您的餘額只有 USDT，請確保您擁有足夠的 USDT 資金來支付所有費用。
- 此外，您也可以選擇以您偏好的加密貨幣指定支付金額。付款將自動以您可用的 USDT 餘額以該加密貨幣進行處理。請務必持有足夠的 USDT 餘額以支付所有相關費用。
要求
查詢參數
| 姓名 | 參數類型 | 預設值 | 定義 |
|---|---|---|---|
| amount* | string | 支付金額 | |
| currency* | string | 付款貨幣代碼如果貨幣是法定貨幣，則需要to_currency 參數。 | |
| order_id* | stringmin:1max:100alpha_dash | 您系統中的訂單 ID參數應為由字母、數字、底線和短劃線組成的字串，不能包含空格和特殊字元。order_id 在商家付款中必須是唯一的當我們找到具有 order_id 的現有付款時，我們會返回其詳細信息，不會創建新的付款。 | |
| address* | string | 提現錢包地址 | |
| is_subtract* | boolean | 定義提款費用的扣除地點true - 來自你的餘額false - 從支付金額中，支付金額將減少 | |
| network* | string | 區塊鏈網路程式碼當 currency/to_currency 是加密貨幣且只有一個網路時不需要，例如 BTC | |
| url_callback | 帶有付款狀態的 webhook 將會傳送到的 URL | ||
| to_currency | 付款時使用的加密貨幣代碼。當 currency 參數為法幣時使用此代碼。請參閱下方範例。 | ||
| course_source | string可用值• Binance• BinanceP2p• Exmo• Kucoin | 來自商家設定的值 | 發票中採用其匯率轉換的服務。此參數僅當貨幣為法定貨幣時才適用，否則預設值取自商家的設定。 |
| 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定義
付款貨幣代碼如果貨幣是法定貨幣，則需要to_currency 參數。參數類型
stringmin:1max:100alpha_dash定義
您系統中的訂單 ID參數應為由字母、數字、底線和短劃線組成的字串，不能包含空格和特殊字元。order_id 在商家付款中必須是唯一的當我們找到具有 order_id 的現有付款時，我們會返回其詳細信息，不會創建新的付款。參數類型
string定義
提現錢包地址參數類型
boolean定義
定義提款費用的扣除地點true - 來自你的餘額false - 從支付金額中，支付金額將減少參數類型
string定義
區塊鏈網路程式碼當 currency/to_currency 是加密貨幣且只有一個網路時不需要，例如 BTC定義
帶有付款狀態的 webhook 將會傳送到的 URL定義
付款時使用的加密貨幣代碼。當 currency 參數為法幣時使用此代碼。請參閱下方範例。參數類型
string
可用值- Binance- BinanceP2p- Exmo- Kucoin定義
發票中採用其匯率轉換的服務。此參數僅當貨幣為法定貨幣時才適用，否則預設值取自商家的設定。參數類型
string定義
允許自動轉換提款金額並使用 from_currency 餘額。僅支援 USDT。參數類型
stringmin: 4max: 11
可用值- recommended- economy- high- highest定義
選擇提現優先權的參數。提現手續費的計算取決於所選的參數。此參數僅適用於使用 BTC、ETH、POLYGON 和 BSC 網路的情況。參數類型
stringmin: 1max: 30定義
TON 的附加標識符，用於指定特定的接收者或目標
* - 必需參數
請求範例
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 | 付款貨幣代碼 |
| network | 進行支付的區塊鏈網路程式碼 |
| address | 付款錢包的地址 |
| txid | 區塊鏈中的交易ID |
| status | 付款狀態 查看所有可用狀態 |
| is_final | 付款是否已完成付款成功或失敗後，付款流程即視為完成。如果付款失敗，資金將退回您的餘額，您需要重新發起付款流程。 |
| balance | 商家餘額中的剩餘資金。 |
| payer_currency | 實際支付的加密貨幣代碼。支付地址將接收支付貨幣。 |
| payer_amount | 付款金額（以 payer_currency 為單位）。 |
定義
付款的 uuid定義
以貨幣支付的金額定義
付款貨幣代碼定義
進行支付的區塊鏈網路程式碼定義
付款錢包的地址定義
區塊鏈中的交易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}如果我們找不到執行付款的服務，您將收到此錯誤訊息。您必須確保該加密貨幣受支援。請檢查以下各項的正確性：currency、network、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}