# 2. 查询代付状态接口
# 简要描述
- 商户代付-查询接口
# HTTP请求信息
# 请求URL
{domain}/open-api/disbursement/check
# 请求方式
- POST
# 请求头
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
Content-Type | mandatory | string | application/json |
# 请求体参数
参数名 | 必选 | 类型 | 长度限制 | 示例 | 说明 |
---|---|---|---|---|---|
appId | 是 | string | - | - | 应用APPID |
param | 是 | string | - | - | 参数体 |
sign | 是 | string | - | 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 | 签名 |
# param 参数
参数名 | 必选 | 类型 | 长度限制 | 示例 | 说明 |
---|---|---|---|---|---|
mchOrderId | 否 | string | 1-32 | - | 商户订单id (mchOrderId 和 transactionId 传其中之一) |
transactionId | 否 | string | 1-32 | - | 交易编号 (mchOrderId 和 transactionId 传其中之一) |
countryCode | 是 | string | - | - | 国家编码 (PH , ID , MY , TH ) |
timestamp | 是 | long | 当前时间戳 |
# 请求体示例
{
"appId": "733b887a4a784708bb369524db5b6ded",
"sign": "Platform",
"param": "{\"mchOrderId\":\"Platform0001\",\"countryCode\":\"PH\",\"timestamp\":\"1677133173758\"}"
}
# 响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | integer | 响应码 |
message | string | 响应信息 |
data | Object | 数据 |
# data参数
参数名 | 类型 | 示例 | 说明 |
---|---|---|---|
mchOrderId | String | - | 商户订单号 |
transactionId | String | D1656505190221611009 | Platform系统订单号,Platform系统唯一标识 |
countryCode | String | - | 国家编码 (PH , ID , MY , TH ) |
currency | String | - | 标价币种 (PHP , IDR , MYR , THB ) |
amount | long | 3000 | 交易金额 (单位为分, 当国家为印尼时, 单元为元) |
transactionStatus | String | 参考列表 | 交易状态 (PENDING , COMPLETED , FAILED ) |
createTime | String | - | 交易创建时间 |
returnTime | String | - | 交易完成时间 |
remark | String | - | 备注 |
failedCode | String | 参考列表 | 交易错误码 |
failedMessage | String | - | 交易错误信息 |
# 返回示例
# 响应参数
{
"code": 10000,
"message": "Success",
"data": {
"mchOrderId": "8af3776584873647100",
"transactionId": "D1656505190221611008",
"amount": 3000,
"transactionStatus": "FAILED",
"createTime": "2024-07-18T19:32:25+08:00",
"returnTime": "2024-07-18T19:33:45+08:00",
"failedCode": -10004,
"failedMessage": "Transaction Channel Rejected"
}
}
# 失败返回示例
{
"code": 21010,
"message": "transaction not found",
"data": null
}