API 状态查询

请求

交易状态查询API使商户能够获取实时交易状态信息。支持的交易类型包括收款交易、付款交易和其他交易类型。

请求路径：

沙盒环境：https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
生产环境：https://gateway.smilepayz.com/v2.0/inquiry-status

请求头参数

字段	必填	类型	描述
Content-Type	是	String	HTTP内容类型规范固定值：application/json 正确解析请求所必需
X-TIMESTAMP	是	String	ISO 8601日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-06:00 注意：必须是当前服务器时间，误差在±5分钟内
X-SIGNATURE	是	String	请求认证的数字签名参见签名生成
X-PARTNER-ID	是	String	平台分配的唯一商户标识符格式：字母数字字符串用于商户认证和交易路由请输入merchantID

请求体参数

字段	必填	类型	描述
tradeType	是	Number	交易类型规格格式：整数值值：1（收款），2（付款）用于识别状态查询的交易类别
orderNo	条件	String(32)	商户交易标识符格式：字母数字字符串最大长度：32个字符按商户交易参考查询时使用
tradeNo	条件	String(32)	内部交易标识符格式：字母数字字符串最大长度：32个字符按系统交易参考查询时使用

重要要求

交易标识符必需： 状态查询必须提供tradeNo或orderNo中的至少一个

请求体示例 – 状态查询请求：

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "tradeType": 1,
    "orderNo": "2000112900000000000001"
}

{
    "tradeType": 2,
    "tradeNo": "112200312406111311517153"
}

响应

HTTP响应

字段	必填	类型	描述
Content-Type	是	String	HTTP响应内容类型规范固定值：application/json 指示JSON响应格式
X-TIMESTAMP	是	String	ISO 8601日期时间格式，带时区偏移格式：yyyy-MM-ddTHH:mm:ss±HH:mm 示例：2020-12-17T10:55:00-06:00

响应体参数

字段	必填	类型	描述
code	是	String	API响应状态码，指示操作结果格式：两位数字字符串成功："00"，错误：其他代码用于程序化响应处理
message	是	String	人类可读的响应状态描述格式：UTF-8编码字符串提供操作结果的详细信息根据请求语言本地化
tradeNo	否	String	系统跟踪的内部交易参考号格式：系统生成的字母数字字符串用于内部交易管理和支持
tradeType	否	Number	交易类型规格格式：整数值值：1（收款），2（付款）指示查询的交易类别
paymentMethod	否	String	用于交易处理的支付方式格式：预定义支付方式代码示例：BANXICO, SPEI, OXXO, SEVEN_ELEVEN 指示实际使用的支付渠道参见支付方式列表
money	否	Object	交易金额详情，包含货币规格包含确认的交易金额和货币参见货币模型
currency	是	String	ISO 4217货币代码规范固定值：MXN（墨西哥比索）确定支付处理规则和结算货币
amount	是	Number	最小货币单位的交易金额格式：整数值示例：20000表示MXN 20000 范围：100-999999999
status	否	String	当前交易处理状态格式：预定义状态代码示例：PROCESSING, SUCCESS, FAILED, CANCELLED 指示交易的当前状态参见状态模型
remark	否	String	额外的交易信息或备注格式：UTF-8编码字符串包含交易状态的补充详情

Content-type: application/json 
X-TIMESTAMP: 2020-12-17T10:55:00-06:00

{
    "code": "00",
    "message": "成功",
    "money": {
        "amount": 20000,
        "currency": "MXN"
    },
    "paymentMethod": "BANXICO",
    "status": "SUCCESS",
    "tradeNo": "122200312406111311517153",
    "tradeType": 2
}

API 状态查询

# 请求

# 请求路径：

# 请求头参数

# 请求体参数

# 请求体示例 – 状态查询请求：

# 响应

# HTTP响应

# 响应体参数

请求

请求路径：

请求头参数

请求体参数

请求体示例 – 状态查询请求：

响应

HTTP响应

响应体参数