商户查询订单状态 API
修订与版本
接口
- URL:
/api/v2/merchant/transaction-request
- 请求方式:
GET
- 认证方式:必需(参见全局认证指南)
请求参数
参数名称 |
类型 |
是否必填 |
描述 |
requestCode |
String(可选) |
否 |
若未提供 merchantOrderNo ,则必填。二者至少填写一个。 |
merchantOrderNo |
String(可选) |
否 |
若未提供 requestCode ,则必填。二者至少填写一个。 |
响应参数
APIMerchantTransactionRequestResponse
字段
参数名称 |
类型 |
描述 |
requestCode |
String |
系统分配的唯一请求标识码 |
tradeType |
TradeType |
交易类型:Deposit (存款)或 Withdraw (提现) |
clientName |
String |
客户真实姓名 |
requestAmount |
BigDecimal |
交易请求金额 |
requestCurrency |
String |
请求金额的币种 |
fiatCurrency |
CurrencyCode |
法币币种:CNY 或 HKD |
paymentMethod |
PaymentOption(可选) |
支付方式:BankCard 、WeChatPay 、Alipay 、Blockchain 、Account |
status |
RequestStatus |
交易状态:Reviewing (审核中)、Matching (匹配中)、InProgress (进行中)、Finished (已完成)、 Failed (失败)、Cancelled (已取消) |
endedAt |
Long(时间戳) |
交易完成或终止时间 |
endedReason |
String |
交易完成、失败或取消的原因 |
source |
String |
请求来源:MerchantBackend 、API_V1 、API_V2 |
merchantOrderNo |
String |
商户自定义的唯一订单编号 |
internalOrderNo |
String |
系统生成的内部订单编号 |
unitPrice |
BigDecimal |
适用的汇率(每单位兑换价格) |
transactionAmount |
BigDecimal |
实际交易金额 |
receivedAmount |
BigDecimal |
客户实际收到的法币金额 |
transactionFee |
BigDecimal |
扣除的交易手续费 |
paymentAmount |
BigDecimal |
客户实际支付的总金额 |
expiredAt |
Long(时间戳) |
订单/请求的过期时间 |
createdAt |
Long(时间戳) |
请求创建时间 |
modifiedAt |
Long(时间戳) |
请求/订单的最后修改时间 |
请求示例
curl -X GET https://{YOUR_ENDPOINT}/api/v2/merchant/transaction-request?merchantOrderNo=TEST_ORDER \
-H "Content-Type: application/json;charset=UTF-8" \
-H "access_key: {YOUR_ACCESS_KEY}" \
-H "signature: {GENERATED_BY_Hmac256}" \
-H "timestamp: {TIMESTAMP_IN_MILLISECONDS}"
响应示例
{
"data": {
"requestCode": "fd9ef3a5cc7b49a088d0cecca789f27f",
"tradeType": "Deposit",
"clientName": "TEST_USER",
"requestAmount": 1234.56,
"requestCurrency": "CNY",
"fiatCurrency": "CNY",
"paymentMethod": "BankCard",
"status": "Finished",
"endedAt": 1741725033033,
"endedReason": "",
"source": "API_V2",
"merchantOrderNo": "TEST_ORDER",
"internalOrderNo": "AT-D-3TEHN1X9U",
"unitPrice": 7.47,
"transactionAmount": 165.27,
"receivedAmount": 160.31,
"transactionFee": 4.96,
"paymentAmount": 1234.56,
"expiredAt": 1741732188336,
"createdAt": 1741724988336,
"modifiedAt": 1741725033228
},
"isSuccess": true,
"statusCode": "SUCCESS",
"message": "",
"version": "2.0"
}