付款記錄
post https://api.cryptomus.com/v1/payout/list 複製
要求
查詢參數
| 姓名 | 參數類型 | 預設值 | 定義 |
|---|---|---|---|
| date_from | stringformat: YYYY-MM-DD H:mm:ss | null | 按建立日期過濾，從 |
| date_to | stringformat: YYYY-MM-DD H:mm:ss | null | 按建立日期過濾， |
參數類型
stringformat: YYYY-MM-DD H:mm:ss預設值
null定義
按建立日期過濾，從參數類型
stringformat: YYYY-MM-DD H:mm:ss預設值
null定義
按建立日期過濾，
請求範例
curl https://api.cryptomus.com/v1/payout/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json'
按 5 月 4 日至 5 月 16 日的建立日期過濾付款。
curl https://api.cryptomus.com/v1/payout/list \
-X POST \
-H 'merchant: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: f80fa426a89eb62bd53997326865d850' \
-H 'Content-Type: application/json' \
-d '{
"date_from": "2023-05-04 00:00:00",
"date_to": "2023-05-16 23:59:59"
}'回覆
響應參數
結構 物品
| 姓名 | 參數類型 | 定義 |
|---|---|---|
| uuid | string | 付款的 uuid |
| amount | string | 以貨幣支付的金額 |
| currency | string | 付款貨幣代碼 |
| network | string|null | 進行支付的區塊鏈網路程式碼 |
| payer_currency | string|null | 實際支付的加密貨幣代碼。支付地址將接收支付貨幣。 |
| payer_amount | string|null | 付款金額（以 payer_currency 為單位）。 |
| address | string | 付款錢包的地址 |
| txid | string|null | 區塊鏈中的交易ID |
| status | string | 付款狀態 狀態 |
| payment_status | string | 付款狀態 |
| is_final | boolean | 付款是否已完成付款成功或失敗後，付款流程即視為完成。如果付款失敗，資金將退回您的餘額，您需要重新發起付款流程。 |
| balance | string|null | 商家錢包中的剩餘資金。 |
| order_id | string|null | 您系統中的訂單 ID |
| commission | string|null | Cryptomus 佣金金額 |
| merchant_amount | string|null | 從商家餘額中扣除的金額，包括所有佣金。 |
| created_at | string|null | 付款創建日期。時區為 UTC+3 |
| updated_at | string|null | 上次付款更新日期。時區為 UTC+3 |
| convert | 有關付款將自動兌換成的貨幣的資訊。兌換將從 payer_currency 轉換為 USDT如果傳遞了 from_currency 參數，則存在。 | |
| convert.to_currency | string|null | 付款將轉換至的貨幣代碼 |
| convert.from_currency | string | 從貨幣 |
| convert.commission | string | 轉換費 |
| convert.rate | string|null | 轉換率 |
| convert.from_amount | string|null | 金額來自 |
參數類型
string定義
付款的 uuid參數類型
string定義
以貨幣支付的金額參數類型
string定義
付款貨幣代碼參數類型
string|null定義
進行支付的區塊鏈網路程式碼參數類型
string|null定義
實際支付的加密貨幣代碼。支付地址將接收支付貨幣。參數類型
string|null定義
付款金額（以 payer_currency 為單位）。參數類型
string定義
付款錢包的地址參數類型
string|null定義
區塊鏈中的交易ID參數類型
string參數類型
string定義
付款狀態參數類型
boolean定義
付款是否已完成付款成功或失敗後，付款流程即視為完成。如果付款失敗，資金將退回您的餘額，您需要重新發起付款流程。參數類型
string|null定義
商家錢包中的剩餘資金。參數類型
string|null定義
您系統中的訂單 ID參數類型
string|null定義
Cryptomus 佣金金額參數類型
string|null定義
從商家餘額中扣除的金額，包括所有佣金。參數類型
string|null定義
付款創建日期。時區為 UTC+3參數類型
string|null定義
上次付款更新日期。時區為 UTC+3定義
有關付款將自動兌換成的貨幣的資訊。兌換將從 payer_currency 轉換為 USDT如果傳遞了 from_currency 參數，則存在。參數類型
string|null定義
付款將轉換至的貨幣代碼參數類型
string定義
從貨幣參數類型
string定義
轉換費參數類型
string|null定義
轉換率參數類型
string|null定義
金額來自
若要取得下一頁/上一頁條目，請在查詢參數中指定下一頁/上一頁遊標哈希 (?cursor=nextCursorHash)
例子：
1curl https://api.cryptomus.com/v1/payout/list?cursor=eyJpZCI6MjEyLCJf cG9pbnRzVzVG9OZXh0SXRlbXMiOnRydWV9 \
2-X POST \
3-H 'merchant: cb2131ff-a3d4-46dd-94c6-3714fae65f89' \
4-H 'sign: f80fa426a89eb62bd53997326865d850' \
5-H 'Content-Type: application/json' \
6回應範例
1{
2"state": 0,
3"result": {
4 "merchant_uuid": "8b03432e-385b-4670-8d06-064591096795",
5 "items": [{
6 "uuid": "a7c0caec-a594-4aaa-b1c4-77d511857594",
7 "amount": "3",
8 "currency": "USDT",
9 "network": "TRON",
10 "payer_currency": "USDT",
11 "payer_amount": "3",
12 "address": "TJ...",
13 "txid": null,
14 "status": "process",
15 "payment_status": "process",
16 "is_final": false,
17 "balance": "129.00000000",
18 "order_id": "1",
19 "commission": null,
20 "merchant_amount": null,
21 "created_at": "2023-06-21T17:25:55+03:00",
22 "updated_at": "2023-06-21T17:34:38+03:00"
23 }, {
24 "uuid": "92c39264-d180-4503-9c16-ee16f083bbb8",
25 "amount": "5.40000000",
26 "currency": "DOGE",
27 "network": "doge",
28 "payer_currency": "DOGE",
29 "payer_amount": "5.40000000",
30 "address": "DEw8CJLfxg9fhumeXP1zvVNjZicsqtDv7V",
31 "txid": "5e5810946152ea569d2a2aa9aa32a45c0e4223a4f9aad8e31d2fc660d2cdedb8",
32 "status": "paid",
33 "payment_status": "paid",
34 "is_final": true,
35 "balance": "26.77966652",
36 "order_id": null,
37 "commission": "0.00000000",
38 "merchant_amount": "5.40000000",
39 "created_at": "2023-07-21T17:25:55+03:00",
40 "updated_at": "2023-07-21T17:34:38+03:00"
41 },
42 ...
43 ],
44 "paginate": {
45 "count": 15,
46 "hasPages": true,
47 "nextCursor": "eyJpZCI6MjkxNTU0MywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
48 "previousCursor": null,
49 "perPage": 15
50 }
51}
52}可能的錯誤
驗證錯誤
程式碼 : 422
範例回覆：
如果 date_from 或 date_to 參數傳遞的格式錯誤。
1{
2 "state": 1,
3 "errors": {
4 "date_from": ["validation.regex"]
5 }
6}