API 查询状态
大约 3 分钟
请求
交易状态查询API使商户能够检索实时交易状态信息。支持的交易类型。
请求路径：
沙盒:
https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
生产:https://gateway.smilepayz.com/v2.0/inquiry-status
请求头参数
| 字段 | 必需 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | HTTP内容类型规范 固定值：application/json 正确请求解析必需 |
| X-TIMESTAMP | M | String | ISO 8601日期时间格式，带时区偏移 格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00+07:00 注意：必须是当前服务器时间，误差±5分钟内 |
| X-SIGNATURE | M | String | 请求认证的数字签名 参见签名生成 |
| X-PARTNER-ID | M | String | 平台分配的唯一商户标识符 格式：字母数字字符串 用于商户认证和交易路由 请输入merchantID |
请求体参数
| 字段 | 必需 | 类型 | 描述 |
|---|---|---|---|
| tradeType | M | Number | 交易类型规范 格式：整数值 值：1（收款）、2（付款） 用于识别状态查询的交易类别 |
| orderNo | C | String(32) | 商户交易标识符 格式：字母数字字符串 最大长度：32个字符 按商户交易参考查询时使用 |
| tradeNo | C | String(32) | 内部交易标识符 格式：字母数字字符串 最大长度：32个字符 按系统交易参考查询时使用 |
重要要求
交易标识符必需: 交易状态查询必须提供
tradeNo或orderNo中的至少一个
请求体示例 – 查询状态请求：
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001
{
"tradeType": 1,
"orderNo": "2000112900000000000001"
}
{
"tradeType": 2,
"tradeNo": "112200312406111311517153"
}
响应
HTTP响应
| 字段 | 必需 | 类型 | 描述 |
|---|---|---|---|
| Content-Type | M | String | HTTP响应内容类型规范 固定值：application/json 指示JSON响应格式 |
| X-TIMESTAMP | M | String | ISO 8601日期时间格式，带时区偏移 格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00+07:00 |
响应体参数
| 字段 | 必需 | 类型 | 描述 |
|---|---|---|---|
| code | M | String | API响应状态码，指示操作结果 格式：两位数字字符串 成功："00"，错误：其他代码 用于程序化响应处理 |
| message | M | String | 人类可读的响应状态描述 格式：UTF-8编码字符串 提供操作结果的详细信息 基于请求语言本地化 |
| tradeNo | O | String | 系统跟踪的内部交易参考号码 格式：系统生成的字母数字字符串 用于内部交易管理和支持 |
| tradeType | O | Number | 交易类型规范 格式：整数值 值：1（收款）、2（付款） 指示查询的交易类别 |
| paymentMethod | O | String | 用于交易处理的支付方式 格式：预定义支付方式代码 示例：CPF、PIX、BOLETO 指示实际使用的支付渠道 参见支付方式列表 |
| money | O | Object | 带货币规格的交易金额详情 包含确认的交易金额和货币 参见金额模型 |
| currency | M | String | ISO 4217货币代码规范 固定值：BRL（巴西雷亚尔） 确定支付处理规则和结算货币 |
| amount | M | Number | 最小货币单位的交易金额 格式：整数值 示例：20000表示BRL 20000 范围：100-999999999 |
| status | O | String | 当前交易处理状态 格式：预定义状态代码 示例：PROCESSING、SUCCESS、FAILED、CANCELLED 指示交易的当前状态 参见状态模型 |
| remark | O | String | 额外交易信息或备注 格式：UTF-8编码字符串 包含交易状态的补充详情 |
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
{
"code": "00",
"message": "Successful",
"money": {
"amount": 20000,
"currency": "BRL"
},
"orderNo": "2000112900000000000001",
"paymentMethod": "PIX",
"status": "SUCCESS",
"tradeNo": "112200312406111311517153",
"tradeType": 1
}