接口介绍

本接口用于生成 高级服务商、普通服务商、业务员、商户等角色的对账单 的下载链接,由于对账单生成需要一定的时间(时间不固定,一般10分钟以内),所以在本接口会返回一个对账单下载链接的查询token,然后通过接口 服务商对账单生成进度查询 来查询对账单生成的进度。

生成的对账单格式为csv,具体介绍请参见:服务商对账单生成进度查询

注: 生成的下载链接一周内有效,可以重复下载, 超过一周需要重新生成。

参数简介

公共参数

参数名 参数类型 参数介绍 是否必填
command String(32) 接口名,固定为:open.api.agent.download.csv
app String(32) 接入商标识
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 签名,详见MD5签名RSA256签名

参数简介

参数名 参数类型 参数介绍 是否必填
trade_date String(16) 交易日期,格式:yyyy-MM-dd,最多填入一年内的一个日期
agent_code String(16) 服务商编码
salesman_id Long 业务员ID
merchant_code String(16) 商户编码

返回值说明

公共返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
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 签名值 具体参照: 接口验签规则

数据返回值

参数名 所属结构 返回值类型 返回值说明 特殊备注
token data String(32) 用于查询生成进度的token 参与签名

返回值举例

{
    "data": {
        "request_id": "4eaf2b39-d91a-443a-8445-379712d85816",
        "request_time": "20180926164558",
        "response_time": "20180926164846",
        "token": "xxxxxxxxxxxxxxxxx"
    },
    "result": {
        "success": true
    },
    "sign": "LSAB33dR6iYCf5Qn9w4MvUokSwR1ZYgmbYZAQ4pLQSfwYTquyyqwEzkZ6ZPV07JT+F4hudAFigRPYxdod/SBjMkdIn20cTn5HaOGiQ2UopemBZzn9mbakjBvJOdWGTxUkTEbV21tTOu9naxqtAQZ0c9P82iJXcj23FN5SOB9uM1Sk0RBhH7yvXhdQuKSFH+HefCR9ushDGiN+JE2WhdqW5Km/scifNPamWh9RLaXAMUpDFhdP9VoC7s0Tsy5dx0YNHIY0zwgbbXVl4v91Nb7OBuNOlhpvzvjwnT1kXh0cKDGiZ39KFjy+92JGCuOOjU7v1kchquqLb408BvGmyGPpQ=="
}

Js Demo

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

results matching ""

    No results matching ""