接口介绍
目前该接口仅支持微信官方通道收款。
该接口对应着微信官方的公众号支付, 用于大家想自己在公众号里定制自己的收款页面(而不用经过我们的中间页,详情见H5支付)。
要想使用此接口,需要先在采宝开通微信官方通道收款,并联系客服小二配置支付关注自己的公众号。
参数简介
参数名 | 参数类型 | 参数介绍 | 是否必填 | 是否参与签名 |
---|---|---|---|---|
command | String(32) | 接口名,用于标识调用哪个接口,微信JSAPI支付:open.pay.mp | 是 | 否 |
operator_id | String(32) | 收银员的id,用于标识收款账户 | 是 | 是 |
app | String(32) | 接入商标识 | 是 | 是 |
version | Double | 接口版本号,默认值1.0 | 是 | 否 |
sign | String(32) | 签名,详见请求签名规则 | 是 | 否 |
local_order_no | String(64) | 接入方的本地订单号,接入方请保证这个订单号的唯一性, 采宝不进行唯一性校验,如果订单号不唯一,会影响查询结果 | 否 | 是 |
amount | Long | 订单总额,以分为单位 | 是 | 是 |
un_discount_amount | Long | 不参与优惠金额,以分为单位 | 否 | 是 |
timestamp | Long | 时间戳,值为当前时间距离19700101的毫秒数 | 是 | 是 |
subject | String(20) | 订单描述,小于20个汉字 | 否 | 是 |
goods_list | String(4096) | 商品列表 | 否 | 是 |
notify_url | String(256) | 支付成功之后的回调地址,具体请参照:支付完成之后的通知 | 否 | 否 |
sub_app_id | String(32) | 配置的支付关注的公众号的app_id | 是 | 是 |
open_id | String(32) | 付款人在sub_app_id对应的公众号下的openId | 是 | 是 |
device_create_ip | String(32) | 发起支付服务器或终端IP地址,格式为8.8.8.8 | 否 | 是 |
wx_hospital_scene | String(64) | 微信医疗场景 | 否 | 否 |
goods_list 介绍
goods_list是商品列表信息, 传入此值后会自动统计商品的销量等信息,并且会被放入订单中。 格式为json格式, 举例如下:
[
{
"goods_id":"", ## 商品id,可空
"goods_num":"", ## 商品编号,这个值用于传入到微信、支付宝等, 用于支持单品券的核销,可空
"goods_name":"", ## 商品名称,可空
"sell_amount":"", ## 卖出数量,不可为空
"goods_price":"", ## 商品单价,不可为空
"goods_sku_id":"" ## 卖出的sku的id,可空
},
{
"goods_id":"", ## 商品id,可空
"goods_num":"", ## 商品编号,这个值用于传入到微信、支付宝等, 用于支持单品券的核销,可空
"goods_name":"", ## 商品名称,可空
"sell_amount":"", ## 卖出数量,不可为空
"goods_price":"", ## 商品单价,不可为空
"goods_sku_id":"" ## 卖出的sku的id,可空
},
{
"goods_id":"", ## 商品id,可空
"goods_num":"", ## 商品编号,这个值用于传入到微信、支付宝等, 用于支持单品券的核销,可空
"goods_name":"", ## 商品名称,可空
"sell_amount":"", ## 卖出数量,不可为空
"goods_price":"", ## 商品单价,不可为空
"goods_sku_id":"" ## 卖出的sku的id,可空
}
......
]
返回值说明
返回值请参照:https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=7_7&index=6
参数名 | 所属结构 | 返回值类型 | 返回值说明 | 特殊备注 |
---|---|---|---|---|
success | result | boolean | 标识这次请求是否成功 | 请不要用这个值来判断收银是否成功。 |
errorCode | result | String | 错误码 | |
errorMsg | result | String | 错误码的详细说明 | |
appId | data | String(16) | 公众号appid,商户注册具有支付权限的公众号成功后即可获得 | 参与签名 |
timeStamp | data | String(32) | 时间戳,当前的时间 | 参与签名 |
nonceStr | data | String(32) | 随机字符串,不长于32位 | 参与签名 |
package | data | String(128) | 详情扩展字符串 | 参与签名 |
signType | data | String(32) | 签名方式 | 参与签名 |
paySign | data | String(64) | 微信公众号支付需要的签名 | 参与签名 |
sign | data | String | 签名值 | 具体参照: 接口返回值的安全校验规则 |
timestamp | data | String | 时间戳 | 参与签名 |
返回值示例
{
"result": {
"success": false,
"errorCode":"10",
"errorMsg": "command参数为空"
}
"data":{
"appId":"",##参与签名
"timeStamp":"",##参与签名
"nonceStr":"",##参与签名
"package":"",##参与签名
"signType":"",##参与签名
"paySign":"",##参与签名
"sign":"", ## 签名值
"timestamp":"" ## 时间戳,参与签名
}
}