10.3 查詢現金通路訂單(代收、代付)
#簡單描述: 此介面用於查詢現金管道代收付訂單,根據訂單號碼能夠查看其訂單詳情。
- 要求方式: POST
- 請求介面: https://网关域名/wallet-trade-merchant/v1/receive/cash/query/by-third
- 請求媒體類型( JSON 資料格式 )Content-Type: application/json
查詢參數
| 參數名稱 | 類型 | 必填 | 參數意義 | 參數說明 |
|---|---|---|---|---|
orderId | string | 否 | 平台訂單號碼 | 我方平台訂單號碼或商家本地訂單號碼2選1 |
localOrderId | string | 否 | 商家本地訂單號碼 | 商家本地訂單號碼或我方平台訂單號碼2選1 |
key | string | 是 | 商家key | apiKey |
sign | string | 是 | 簽章 | 詳情請見簽章演算法 |
請求json範例
{
"key": "9yUreYgTRtit39Dy",
"orderId": 274224939517780,
"sign": "07792d2cf97811d3f2e7bd98edb477e3"
}
傳回值
| 參數名稱 | 類型 | 參數意義 | 參數說明 |
|---|---|---|---|
code | int32 | 請求狀態 | 回傳代碼,0為業務成功,否則代表不同的錯誤 |
success | boolean | 成功狀態 | 成功標識,與code=0一致,用於相容歷史 |
message | string | 說明 | 錯誤訊息。如果有錯誤時,返回的錯誤訊息 |
data | json | 傳回資料 | 參數詳見下列說明 |
返回範例
{
"code": 0,
"success": true,
"message": null,
"data": {
"merchantId": 302992856974,
"merchantUserId": "conan",
"orderId": "477564506808517",
"localOrderId": "conantest9913279",
"type": "PAYMENT",
"status": "SUCCESS",
"currency": "CNY",
"paidAmount": "100",
"amount": "100",
"isReissue": false,
"notifyTime": 1772789295567,
"orderCreateTime": 1772789258844
}
}
data參數說明
| 參數名稱 | 類型 | 參數意義 | 參數說明 |
|---|---|---|---|
merchantId | int64 | 商家ID | |
merchantUserId | string | 商家使用者ID | 對應下單參數 localUserId 的值 |
orderId | string | 訂單號碼 | 我方平台訂單號碼 |
localOrderId | string | 商家本地訂單號碼 | 商家本地平台訂單號碼(對應下單參數 localOrderId 的值) |
type | enum | 訂單類型 | PAYMENT:支付订单 | WITHDRAW:提款订单 |
status | enum | 訂單狀態 | PROCESSING:处理中| SUCCESS:已完成|FAIL:已失败 |
currency | string | 訂單幣種 | |
paidAmount | number | 訂單應收、付款金額 | |
amount | number | 訂單金額 | |
isReissue | boolean | 是否補發 | |
notifyTime | int64 | 通知時間戳記 | 毫秒 |
orderCreateTime | int64 | 訂單建立時間戳記 | 毫秒 |