接口介绍

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

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

参数简介

参数名 参数类型 参数介绍 是否必填 是否参与签名
command String(32) 接口名,用于标识调用哪个接口,对账单生成进度查询:open.query.download.url 是 否
client_id String(32) 商户的id,用于标识收款账户 是 是
app String(32) 接入商标识 是 是
sign String(32) 签名,详见请求签名规则 是 否
token String(32) 生成对账单时返回的token 是 是

返回值说明

参数名 所属结构 返回值类型 返回值说明 特殊备注
success result boolean 标识这次请求是否成功 请不要用这个值来判断收银是否成功。
errorCode result String 错误码
errorMsg result String 错误码的详细说明
url data String 对账单下载链接 参与签名
sign data String 签名值 具体参照: 接口返回值的安全校验规则
timestamp data String 时间戳 参与签名

返回值举例

{
        "result": {
               "success": false,
                "errorCode":"10",
                "errorMsg": "command参数为空"
        }
        "data":{
            "url":"" 
            ,"sign":"" ## 签名值
            ,"timestamp":"" ## 时间戳,参与签名
        }
}

对账单格式说明

对账单编码为:GBK

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

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

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

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

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

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

备注3:字段解释

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

备注4:支付渠道枚举

支付渠道取值 解释
ALIPAY 支付宝
WECHAT 微信
BAIDUPAY 百度支付
BESTPAY 翼支付
QUICK_PASS 云闪付
CASH 记账
POS POS机刷卡支付
VIPCARD 会员卡支付

备注5:收款渠道枚举

收款渠道枚举 解释
ALIPAY 支付宝
WECHAT 微信
BAIDUPAY 百度支付
BESTPAY 翼支付
MYBANK 网商银行
CASH 记账
POS POS机刷卡支付
VIPCARD 会员卡支付

备注6:交易类型枚举为

交易类型枚举 解释
PAYMENT 支付
REFUND 退款
RECHARGE_PAYMENT 会员卡充值
RECHARGE_REFUND 会员卡充值退款

备注7:交易状态枚举为:

交易状态枚举 解释
PAY_SUC 收款成功
REFUND_SUC 退款成功(针对退款订单)
PARD_REFUND 收款成功(部分退款)
ALL_REFUND 收款成功(全额退款)

results matching ""

    No results matching ""