订单查询接口

客户端系统采用POST方法向平台提交请求,数据格式采用JSON,平台地址为:

https://平台域名/yunke-order/query 
如:https://pay.wn.com/yunke-order/query

请求参数如下:

订单查询POST请求参数
参数名 类型 是否必选 限制 描述 示例
user_id int 系统分配,不可自定义 用户id:商家在平台注册时获得的用户ID 4
order_number string

长度:string[6,32]
仅限大小写字母、数字、下划线

商户订单号:在商家系统中全局唯一 20210530_R060524
sign string 长度string[64]
哈希值

签名字符串:用于保证请求真实、不被篡改、防止重放攻击,通讯必须签名,点击查看签名算法

 

 

接口响应如下:
响应分为公共参数部分和业务参数部分

公共参数部分
参数名 类型 是否必选 限制 描述 示例
code int 三位整数 处理结果的状态码,详见这里 2000
msg string 长度string[1,256] 处理结果的描述短语 “ok”
sign string 长度string[64]
哈希值

签名字符串:用于保证请求真实、不被篡改、防止重放攻击,通讯必须签名,点击查看签名算法

 
业务参数部分(当code状态码指示业务正常时,以下参数才存在)
参数名 类型 是否必选 限制 描述 示例
user_id int 系统分配 用户id:商家在平台注册时获得的用户ID 4
order_number string 长度:string[6,32]
仅限大小写字母、数字、下划线
商户订单号:在商家系统中全局唯一 20210530_R060524
system_number string 目前暂定长度:24位数字
前12位表示时间,8位随机数,4位产品类别
在统一平台中的系统订单号,全局唯一
将来可能会升位,用户应预留32位储存
210602150849375331066319
description string 长度string[1,127]  
仅限汉字、大小写字母、数字、下划线
不可使用特殊字符,如 /,=,& 等。
描述:商品或服务的描述 小米11手机
total float 可带小数点精确到分
取值范围为 0.01~100000000.00
订单总金额:单位元 18.6
amount float 可带小数点精确到分
取值范围为 0.01~100000000.00
订单实收金额:单位元,用户完成付款时和订单金额相同,如果之后有退款发生则再查询时和订单总金额不同 18.6
timeout_express int Unix时间戳( 1970年1月1日 00:00:00 到当前时间的秒数)
与下单时间差值范围在1分钟到15天
交易关闭时间:时间戳,超过该时间将无法付款 1622341093
order_state int

一个数字
0|等待付款、1|已经付款、2|付款失败、3|等待退款、4|已经退款

付款状态
仅在值为1时才能认为是付款成功

1
order_time int Unix时间戳( 1970年1月1日 00:00:00 到当前时间的秒数) 付款用户实际付款时间 1622341093
attach string 长度string[1,128]或空字符串
任意数据,推荐为json字符串
用户随订单传递的自定义附加数据:在查询API和支付通知中原样返回,可作为自定义参数使用 云客:user:drupal

提示:当响应签名验证失败时,必须放弃处理,避免冒用攻击
当签名验证通过,客户端系统应更新本地订单状态,并做相应业务处理(业务处理也可在付款异步通知中进行,或通过其他机制触发执行,如任务队列等)