查询订单接口
本接口只用于微信支付,支付宝支付和银联支付。
API 请求
端点
https://api.iotpaycloud.com/v1/query_order
方法
POST
头部
Content-Type: application/x-www-form-urlencoded
! 提示
在收到访问凭证(商户 ID、登录名、商户密钥)之后, 您可以按照演示查询订单进行测试。 这可能在阅读文档时对您有所帮助。
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户ID | mchId | 是 | String(30) | 1000000010 | 支付中心分配的商户号 |
支付订单号 | payOrderId | 是* | String(30) | P20160427210604000490 | 支付中心生成的订单号 |
商户订单号 | mchOrderNo | 是* | String(30) | 20160427210604000490 | 商户生成的订单号 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
提示
请求参数中只需包含payOrderId
或mchOrderNo
其一即可。
返回结果
字段名 | 变量名 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
返回状态码 | retCode | String(16) | SUCCESS | SUCCESS/FAIL此字段是通信标识,非交易标识,交易是否成功需要查看resCode来判断 |
返回信息 | retMsg | String(128) | 签名失败 | 返回信息,如非空,为错误原因 签名失败 参数格式校验错误 |
以下字段在retCode
为SUCCESS
的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
业务结果 | resCode | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
错误代码 | errCode | 否 | String(32) | SYSTEMERROR | 错误码 |
错误代码描述 | errCodeDes | 否 | String(128) | 系统错误 | 结果信息描述 |
以下字段在retCode
和resCode
都为SUCCESS
的时候有返回
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户ID | mchId | 是 | String(30) | 20001222 | 支付中心分配的商户号 |
商户订单号 | mchOrderNo | 是 | String(30) | 20160427210604000490 | 商户生成的订单号 |
渠道ID | channelId | 是 | String(24) | WX_JSAPI | 见支付渠道参数 |
币种 | currency | 是 | String(3) | CAD | 三位货币代码,加币:CAD |
支付金额 | amount | 是 | int | 100 | 支付金额,单位分 |
客户端IP | clientIp | 否 | String(32) | 210.73.10.148 | 客户端IP地址 |
设备 | device | 否 | String(64) | WEB | 终端设备号(门店号或收银设备ID), 注意:PC网页或公众号内支付请传”WEB |
支付结果回调URL | notifyUrl | 是 | String(200) | http://xxx.com/notify.php | 支付结果回调URL |
商品主题 | subject | 是 | String(64) | 测试商品 | 商品主题 |
商品描述信息 | body | 是 | String(256) | 测试商品描述 | 商品描述信息 |
扩展参数1 | param1 | 否 | String(64) | 支付中心回调时会原样返回 | |
扩展参数2 | param2 | 否 | String(64) | 支付中心回调时会原样返回 | |
附加参数 | extra | 是 | String(512) | {“openId”:”o2RvowBf7sOVJf8kJksUEMceaDqo”} | 特定渠道发起时额外参数,见下面说明 |
支付成功时间 | paySuccTime | 否 | Long | 1505049094262 | 支付成功时间 |
渠道订单号 | channelOrderNo | 否 | String | wx20170910211043fb206e92260071822007 | 对应的第三方支付订单号 |
订单状态 | status | 是 | int | 2 or 3 | 2 or 3代表成功 |
订单状态列表
状态码 | 简介 |
---|---|
0 | 创建成功但未付款 |
1 | 用户正在付款界面, 如用户正在输入密码 |
2 | 已支付成功 |
3 | 已支付成功并且已通知商家 |
4 | 被系统取消 |
9 | 被用户取消 |
提示
轮询订单状态时,仅当状态码为2或3时代表订单成功,若状态码大于3,此订单将再无成功可能,此时可停止轮询。
返回错误
更多返回错误代码请看这里