接口介绍

本接口用于查询对账单的生成结果,在对账单生成之后,本接口会返回对账单的下载url。

建议接入方以一定的频率来轮询本接口(建议频率1-2分钟一次)。

参数简介

公共参数

参数名 参数类型 参数介绍 是否必填
command String(32) 接口名,固定为:open.api.download.url
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签名

参数简介

参数名 参数类型 参数介绍 是否必填
token String(32) 生成对账单时返回的token

返回值说明

公共返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
success result boolean 标识这次请求是否成功
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) 对账单下载链接 参与签名

返回值举例

{
    "data": {
        "request_id": "e8a8ae65-c76b-4e29-a60f-860e2c1c3f24",
        "request_time": "20180929144119",
        "response_time": "20180929144115",
        "url": http://bill.caibaopay.com/A00305710000067/A00305710000067_2018年09月_3f78aba.csv
    },
    "result": {
        "success": true
    },
    "sign": "ad/pgutviWCkE9y1Civn/0RUQFsDt32EIO3/10uzcMK1HmJgq+T6j0z8WzF+lUrnG6Jvj1Ta6QyB0XpXZ4dFaXrSOqSjWLGEOi8gLJ63x+n/4WQIh/fxtdPP64n1vUMgUvQqpW3hYxmwBeqcQthR2hHtValUROiSwi2xMzvIXYRTct0rBofYZNFcPNAXHqXKtGv3W4+PDigWJfCWNPWbINPN53ii2ryy4AHry7+6wb5vcFMeB8CyzNXFqe/xPKbazimG9w5aam3t06JJ3ziZbq3XnYKjpCY7DGgOKce1UvBj/OQiOtp4ml5zsar9KgCsrgF6HL+3CImaMvzuMIU95w=="
}

对账单格式说明

对账单编码为:GBK

生成的对账单格式为csv, 第一行为表头, 从第二行起,为数据记录,各参数以逗号分隔,字段顺序与表头一致。表头格式为:

商户号,交易时间,接入方本地订单号,平台订单号,支付平台订单号,门店名称,门店id,收银员,收银员id,应收金额,实收金额,手续费,结算金额,商家优惠,平台补贴,消费者id,支付渠道,收款渠道,交易类型,交易状态,备注

倒数第二行为统计表头,最后一行为统计数据,字段顺序与统计表头一致。统计表头格式为:

交易额,收款金额,收款笔数,退款金额,退款笔数,商家优惠金额,商家优惠笔数,平台补贴金额,平台补贴笔数,手续费金额

备注1:所有的金额单位均为分。

备注2:对于收款订单,手续费一栏金额为负数,其他金额均为正数。对于退款订单,手续费一栏为正数,其他金额均为负数。

备注3:字段解释

字段名 解释
商户号 采宝商户号
交易时间 交易产生的时间,格式为:yyyy-MM-dd HH:mm-ss
接入方本地订单号 开放平台接入方的订单号(支付接口中的local_order_no),如果不是开放平台订单或者接入方没有传入这个值, 此值为空
平台订单号 采宝产生的订单号(支付接口中的cb_order_no)
支付平台商户号 支付宝、微信、银行产生的订单号
门店名称 门店名称,生成规则:主门店名称(子门店名称)
门店id 门店的数字id
收银员 收银员名称
收银员id 收银员唯一id
应收金额 应收金额(支付接口传入的金额)
实收金额 刨除掉优惠后,实际收到的金额(包含手续费)
手续费 支付平台(支付宝、微信、银行)扣除的手续费,收款渠道为官方(支付宝、微信)的,需要备注签约费率后,此字段才会有值
结算金额 扣除掉手续费之后的结算金额
商家优惠 商家活动的优惠(在采宝平台配置的活动、采宝平台的优惠券、口碑的优惠活动、微信支付后台配置的活动等),举例:商家口碑后台配置全场九折,应收款为:100, 那么商家优惠为:10,实收金额:90
平台补贴 支付平台的优惠补贴,例如支付平台发给消费者的红包(各种补贴大战等), 这部分钱不是消费者支出,但是会结算给商家(已经包含在实收金额中)
消费者id 消费者的唯一id,微信付款则为openId,支付宝则为2088开头的唯一id号
支付渠道 消费者支付的渠道,具体取值请参照:名词解释
收款渠道 商家收款的渠道,具体取值请参照:名词解释
交易类型 交易类型,具体取值请参照:名词解释
交易状态 交易最终状态,具体取值请参照:名词解释
备注 支付过程中传入的备注信息,或者收银员添加的备注信息

Js Demo

http://openapi.caibaopay.com/test/api/v2/downloadUrl.htm

results matching ""

    No results matching ""