接口介绍
目前该接口支持微信官方通道和银行微信通道收款。
该接口对应着微信官方的小程序支付。
要想使用此接口,需要先在采宝开通微信官方通道或银行微信通道收款,并在微信商户后台将小程序与商户进行绑定。
参数简介
公共参数
参数名 | 参数类型 | 参数介绍 | 是否必填 |
---|---|---|---|
command | String(32) | 接口名,固定为:open.api.mini.pay | 是 |
app | String(32) | 接入商标识 | 是 |
operator_id | String(32) | 收银员的id,用于标识收款账户 | 是 |
version | String | 调用的接口版本,固定为:2.0 | 是 |
sign_type | String(32) | 签名类型 MD5、RSA,默认MD5 | 否 |
request_id | String(64) | 请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 | 是 |
request_time | DateTime | 请求发起时间,格式:yyyyMMddHHmmss,请求发起时间,应答方原样返回 | 是 |
sign | String(32) | 签名,详见MD5签名、RSA256签名 | 是 |
参数简介
参数名 | 参数类型 | 参数介绍 | 是否必填 |
---|---|---|---|
local_order_no | String(64) | 接入方的本地订单号,接入方请保证这个订单号的唯一性, 采宝不进行唯一性校验,如果订单号不唯一,会影响查询结果 | 是 |
amount | Long | 订单总额,以分为单位 | 是 |
un_discount_amount | Long | 不参与优惠金额,以分为单位 | 否 |
subject | String(128) | 订单描述,在渠道方订单详情中展示,小于128个字符 | 否 |
remark | String(128) | 订单备注,小于128个字符 | 否 |
goods_list | String(4096) | 商品列表 | 否 |
notify_url | String(256) | 支付成功之后的回调地址,具体请参照:支付完成之后的通知 | 否 |
payment_channel | String(32) | 支付通道 目前支持WECHAT | 是 |
sub_app_id | String(32) | 小程序的appId | 是 |
open_id | String(32) | 付款人在sub_app_id对应的小程序下的openId | 是 |
device_create_ip | String(32) | 发起支付服务器或终端IP地址,格式为8.8.8.8 | 否 |
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,可空
}
......
]
返回值说明
公共返回值
参数名 | 所属结构 | 返回值类型 | 返回值说明 | 特殊备注 |
---|---|---|---|---|
success | result | boolean | 标识这次请求是否成功 | 请不要用这个值来判断收银是否成功,订单的结果以返回的order_status为准。 |
error_code | result | String | 错误码 | |
error_msg | result | String | 错误码的详细说明 | |
request_id | data | String(64) | 请求报文ID | |
request_time | data | DateTime | 请求发起时间,格式:yyyyMMddHHmmss | |
response_time | data | DateTime | 请求返回时间,格式:yyyyMMddHHmmss | |
sign | sign | String | 签名值 | 具体参照: 接口验签规则 |
数据返回值
返回值请参照:https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=7_7&index=6
参数名 | 所属结构 | 返回值类型 | 返回值说明 | 特殊备注 |
---|---|---|---|---|
local_order_no | data | String(64) | 本地订单号 | |
cb_order_no | data | String(64) | 采宝订单号 | |
app_id | data | String(16) | 小程序appId | |
timestamp | data | String(32) | 时间戳,1970-01-01至今的毫秒数 | |
nonce_str | data | String(32) | 随机字符串,不长于32位 | |
package | data | String(128) | 详情扩展字符串 | |
sign_type | data | String(32) | 签名方式 | |
pay_sign | data | String(64) | 微信公众号支付需要的签名 | |
subject | data | String(128) | 订单描述 | |
remark | data | String(128) | 订单备注 |
返回值示例
{
"data": {
"app_id": "wxceb70ebd9ad6b84e",
"nonce_str": "8gkg0hujz8zdc90go3qhhnwjid5rbadl",
"package": "prepay_id=wx271823505363920d5b666f803783420292",
"pay_sign": "446E2DD08F409CA91B65FF0C828D2548",
"request_id": "4ba8671b-0507-46e8-8d59-2e75e7c468f8",
"request_time": "20180927181157",
"response_time": "20180927182343",
"sign_type": "MD5",
"timestamp": "1538043823876"
},
"result": {
"success": true
},
"sign": "PsOf7tGN0+9ojHpn03rz1hmG7JDVPX/zSiwYayA1ZQ8gjhVEkxU0nomR6DhYnbGUqby8xQRbnBpR0go4L+erYQBYVPSsYyBqTKnOzusxSGyfTt4svnYiMpm5wZ0gJ3y9yHqEWK6wYtQUEs/OgUQygQCRT6pT9P3kfHVCV/ojVdDIMbszjBt4nYyMk3/eCczU//pz9Vndz/OJYLFSSZk0YTGKvMNC1kGtugdOERziizOZJUWlsIyh1QN3QNB//+ssJKMSKb5qOx86HECsAgbByoMABHuMAP/2CHfWs4XpLCdd2RvKT5awG7g8prB4rWziTVeZxOS0JK/tX6KR+MtNfg=="
}