接口介绍

四码合一的条码支付接口, 本接口会根据条码自动选择支付方式并完成支付。

参数简介

参数名 参数类型 参数介绍 是否必填 是否参与签名
command String(32) 接口名,用于标识调用哪个接口,条码支付:open.pay.barcode
operator_id String(32) 收银员的id,用于标识收款账户
app String(32) 接入商标识
version Double 接口版本号,默认1.0,当前值只能为1.0和1.1会影响返回值,详情请见返回值部分
sign String(32) 签名,详见请求签名规则
local_order_no String(64) 接入方的本地订单号,接入方请保证这个订单号的唯一性, 采宝不进行唯一性校验,如果订单号不唯一,会影响查询结果
barcode String(32) 用户微信或支付宝的付款码
amount Long 订单总额,以分为单位
un_discount_amount Long 不参与优惠金额,以分为单位
timestamp Long 时间戳,值为当前时间距离19700101的毫秒数
subject String(20) 订单描述,小于20个汉字
goods_list String(4096) 商品列表
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,可空
    }
    ......
]

返回值说明

参数名 所属结构 返回值类型 返回值说明 特殊备注
success result boolean 标识这次请求是否成功 请不要用这个值来判断收银是否成功。
errorCode result String 错误码
errorMsg result String 错误码的详细说明
localOrderNo data String 本地订单号 参与签名
cbOrderNo data String(64) 采宝的订单号,最长64位 参与签名
outOrderNo data String(64) 支付宝、微信等的订单号id,最长64位 参与签名
orderStatus data int 订单状态 该状态用于判断收银是否成功,具体取值请参照:名词解释
totalAmount data long 订单金额(分为单位) 参与签名
receiveAmount data long 收款金额(分为单位)
paymentChannel data int 支付渠道 参与签名,具体取值请参照:名词解释
sign data String 签名值 具体参照: 接口返回值的安全校验规则
timestamp data String 时间戳 参与签名
subject data String 订单主题 只有version大于等于1.1时才会返回
discountAmount data long 优惠金额(分为单位) 只有version大于等于1.1时才会返回
paymentWay data String 付款方式 只有version大于等于1.1时才会返回,具体取值参照:名词解释
payTime data long 支付时间,格式为时间戳 只有version大于等于1.1时才会返回

返回值示例

{
        "result": {
               "success": false,
                "errorCode":"10",
                "errorMsg": "command参数为空"
        }
        "data":{
                "localOrderNo":""##本地订单号,参与签名      
                ,"cbOrderNo":""##采宝的订单号,最长64位,参与签名
                ,"outOrderNo":"" ##支付宝、微信等的订单id,最长64位,参与签名
                ,"orderStatus":""##支付状态
                ,"totalAmount":""##订单金额,参与签名
                ,"receiveAmount":""## 收款金额
                ,"paymentChannel":"",##支付渠道,1支付宝,2微信,3百度钱包,4翼支付,参与签名
                ,"sign":"" ## 签名值
                ,"timestamp":"" ## 时间戳,参与签名
                ##===========以下字段只有version大于等于1.1时才会返回========
                ,"subject":"" ## 订单主题
                ,"discountAmount":""##优惠金额
                ,"paymentWay":""##付款方式
                ,"payTime":""##付款时间
        }
}

js demo

https://openapi.caibaopay.com/test/api/barcode.htm

results matching ""

    No results matching ""