接口介绍
H5支付接口, 本接口会返回一个链接,消费者用支付宝、微信直接打开这个链接可以进行支付。
参数简介
公共参数
参数名 |
参数类型 |
参数介绍 |
是否必填 |
command |
String(32) |
接口名,固定为:open.api.h5 |
是 |
app |
String(32) |
接入商标识 |
是 |
operator_id |
String(32) |
收银员的id,用于标识收款账户 |
是 |
version |
String(16) |
调用的接口版本,固定为:2.0 |
是 |
sign_type |
String(32) |
签名类型 MD5、RSA,默认MD5 |
否 |
request_id |
String(64) |
请求报文ID,唯一定位一次报文请求,由发起方生成,应答方原样返回,uuid生成,全局唯一 |
是 |
request_time |
String(32) |
请求发起时间,格式: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个字符 |
否 |
confirm_way |
String(16) |
提交方式,默认:NORMAL,NORMAL(普通方式提交支付)、AUTO_PAY(自动提交支付) |
否 |
goods_list |
String(4096) |
商品列表 |
否 |
notify_url |
String(256) |
支付成功之后的回调地址,具体请参照:支付完成之后的通知 |
否 |
redirect_url |
String(256) |
支付成功之后的跳转页面 |
否 |
device_create_ip |
String(32) |
发起支付服务器或终端IP地址,格式为8.8.8.8 |
否 |
wx_hospital_scene |
String(64) |
微信医疗场景 |
否 |
expire_in |
Long |
生成的链接的时效时间(单位为秒),取值范围为60(一分钟)至86400(一天) |
否 |
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 |
String(32) |
请求发起时间,格式:yyyyMMddHHmmss |
|
response_time |
data |
String(32) |
请求返回时间,格式:yyyyMMddHHmmss |
|
sign |
sign |
String |
签名值 |
具体参照: 接口验签规则 |
数据返回值
参数名 |
所属结构 |
返回值类型 |
返回值说明 |
特殊备注 |
url |
data |
String(256) |
生成的h5链接 |
|
local_order_no |
data |
String(64) |
本地订单号 |
|
total_amount |
data |
Long |
收款总额,分为单位 |
|
subject |
data |
String(128) |
订单描述 |
|
remark |
data |
String(128) |
订单备注 |
返回值示例
{
"data": {
"local_order_no": "OPENAPI201809261650376785322",
"request_id": "68e9ef51-0ce2-4417-8750-5533b2ddfa02",
"request_time": "20180926165037",
"response_time": "20180926165032",
"total_amount": 1,
"url": "https://openapi.caibaopay.com/qr/payPage.htm?tid=44317026398F4D1B8FACF252DC5451F4"
},
"result": {
"success": true
},
"sign": "QrJxniFYlD3K+9GZ2pN2vF+fc7WU9gFdlIA42z3k/wCVtOWuVDLCbqgWChnoLSn1owa9QiWaO0ysVQLHCIE9BW5wP5Vf2DQ4Eo+2qVDg23+/TUyzj8k9+KxivnPgX38BzboV+Rl92F8ZnmZjK3M0ah78WYo4hLNBBcGWSfkPnTCQ6Pj0Jf/rhaTElQbSEgqvskpBmhdcf/kQJabCIm1yS9cV86YWCC2QUV/V6i9fSNihVeTO0ngVFLw6RgPd8ulPJmECiSwCfF/6S7GRZTAKCX73GAJTXxl1XraxxQmp3JCuXCH12NNzXaHwCNrIpoqckbD2zpiqUxQKqPXdz4wpOA=="
}
Js Demo
http://openapi.caibaopay.com/test/api/v2/h5Pay.htm