API 查询状态
大约 2 分钟
请求
交易状态查询 API 使商户可查询实时交易状态。支持收款(Pay-In)、付款(Pay-Out)等类型。
请求路径:
沙盒:
https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
生产:https://gateway.smilepayz.com/v2.0/inquiry-status
请求头参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | 固定值:application/json |
| X-TIMESTAMP | M | String | ISO 8601 日期时间,带时区 须为当前服务器时间,误差在 ±5 分钟内 |
| X-SIGNATURE | M | String | 请求签名 参见签名生成 |
| X-PARTNER-ID | M | String | 商户 ID(merchantID) |
请求体参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| tradeType | M | Number | 交易类型:1 收款,2 付款 |
| orderNo | C | String(32) | 商户订单号(按商户参考查询时使用) |
| tradeNo | C | String(32) | 系统交易号(按系统参考查询时使用) |
重要
至少填一项: 须提供
tradeNo或orderNo其中之一
请求体示例
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+08:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001
{
"tradeType": 1,
"orderNo": "2000112900000000000001"
}
{
"tradeType": 2,
"tradeNo": "192200312406111311517153"
}
响应
HTTP 响应
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | application/json |
| X-TIMESTAMP | M | String | ISO 8601 日期时间,带时区 |
响应体参数
| 字段 | 必填 | 类型 | 描述 |
|---|---|---|---|
| code | M | String | 状态码,00 表示成功 |
| message | M | String | 状态说明 |
| tradeNo | O | String | 系统交易号 |
| tradeType | O | Number | 交易类型:1 收款,2 付款 |
| paymentMethod | O | String | 支付方式 收款示例:W_MOMO、W_ZALO、W_VIETTEL、VIET_QR 付款示例:ABB、ACB、VCB 等 参见支付方式列表 |
| money | O | Object | 金额与币种(currency: VND, amount) 参见货币模型 |
| status | O | String | 当前状态 参见状态模型 |
| remark | O | String | 备注或补充信息 |
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+08:00
{
"code": "00",
"message": "成功",
"tradeNo": "192200312406111311517153",
"tradeType": 2,
"paymentMethod": "W_MOMO",
"money": {
"currency": "VND",
"amount": 20000
},
"status": "SUCCESS"
}
