本文档为开放平台对外接入指引,用于应用方按日拉取我方对账单(交易订单明细)进行对账。
接口路径前缀:对账接口/v1/open/dump/reconciliation,接口目录编号 4.2.1。
对账单为 异步 生成:先创建下载任务,再轮询任务查询接口获取下载地址(不提供回调通知)。所有接口均为 POST,请求体为开放平台统一信封( requestId/timestamp/nonce/sign/reqBody),应答体为统一信封(code/msg/timestamp/sign/nonce/rspBody),签名与验签规则见「2.2」章节。
| 项目 | 口径 |
|---|---|
| 对账单数据源 | 我方交易订单(pay_trade_order),与运营端「交易订单导出」完全同源同模板 |
| 日期口径 | 按结算时间(settle_time)取账单日当天的交易;同时限定订单创建时间在结算日往前 3 天内 |
| 交易状态口径 | 固定包含 支付成功(1) 与 退款成功(5) 两类,不可由调用方指定 |
| 商户范围 | 由调用方应用关联商户的商户类型自动确定,见下表 |
| 账单日期范围 | 单日(billDate),不可跨天;最早可回溯 90 天,不支持未来日期 |
| 文件保留期 | 任务创建后 7 天(expireTime),过期需重新创建任务 |
| 下载地址有效期 | 10 分钟(每次查询任务重新签发签名地址),获取后请尽快下载 |
| 文件格式 | ZIP 压缩包,内含 1 个 xlsx 文件 |
| 金额格式 | 交易金额/手续费/结算金额均为元,形如 1,234.89;费率字段为万分比整数 |
| 应用关联商户类型 | 出账范围 | 传 merchantNo 时 |
|---|---|---|
| 普通商户(1) | 仅本商户交易 | 只允许传本商户编号 |
| 代理商户(2) | 该代理下挂全部商户的交易 | 允许传本商户或下挂商户编号,仅出该商户交易 |
| 品牌商户(3) | 该品牌下挂全部商户的交易 | 允许传本商户或下挂商户编号,仅出该商户交易 |
指定 merchantNo时按单出账,不再叠加层级范围;传入非本应用下挂商户返回12103。
billDate(通常为前一日)。taskId,此时 status=1(等待中)、无下载地址。taskId,不会重复生成文件。taskId 调用 4.2.1.2,读取 status:1 等待中 / 2 进行中:继续轮询;3 成功:返回 downloadUrl,进入第三步;4 失败:终止本轮对账并告警,重新调用 4.2.1.1 会创建新任务。downloadUrl 直接 GET 下载 ZIP(签名地址,无需再带任何请求头)。4.2.1.3 用于查询历史任务与补偿:本地任务记录丢失、或需批量核对某段时间任务结果时使用。
| 接口编号 | 接口路径 | 方法名 | 说明 |
|---|---|---|---|
| 4.2.1.1 | POST /v1/open/dump/reconciliation/task/create | createTask | 对账单下载任务创建 |
| 4.2.1.2 | POST /v1/open/dump/reconciliation/task/get | getTask | 对账单下载任务查询(获取下载地址) |
| 4.2.1.3 | POST /v1/open/dump/reconciliation/task/page | pageTask | 对账单下载任务分页查询 |
reqBody:| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| billDate | String | 是 | 账单日期,格式 yyyy-MM-dd;不晚于当天,最早回溯 90 天 |
| merchantNo | String | 否 | 指定出账商户;不传时按应用商户类型对其全部下级出账 |
rspBody:| 字段 | 类型 | 说明 |
|---|---|---|
| taskId | Integer | 任务编号,后续查询与下载均以此为准 |
| billDate | String | 账单日期 |
| status | Integer | 任务状态,创建后为 1 |
| statusDesc | String | 任务状态描述 |
| fileName | String | 对账文件名(ZIP,内含同名 xlsx) |
| downloadUrl | String | 下载地址,任务未完成时为空 |
| expireTime | String | 文件保留截止时间,yyyy-MM-dd HH:mm:ss |
| createTime | String | 任务创建时间 |
reqBody:| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | Integer | 是 | 4.2.1.1 返回的任务编号 |
rspBody: 字段同 4.2.1.1,其中:status=3 且未过 保留期 → 必带 downloadUrl(签名地址,10 分钟内有效);12202,需用同一 billDate 重新调用 4.2.1.1;taskId 不属于当前应用 → 统一返回 12201 对账任务不存在。reqBody:| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| pageNum | Integer | 否 | 页码,默认 1 |
| pageSize | Integer | 否 | 每页条数,默认 10,最大 100 |
| status | Integer | 否 | 按任务状态过滤,不传返回全部状态 |
rspBody:| 字段 | 类型 | 说明 |
|---|---|---|
| list | Array | 任务列表,元素结构同 4.2.1.1,按任务编号倒序 |
| total | Long | 总记录数 |
| pageNum | Integer | 当前页码 |
| pageSize | Integer | 每页条数 |
列表中的任务为已过文件保留期时,该条 downloadUrl返回空,不报错;需要下载地址请逐条调用 4.2.1.2。
| 列 | 说明 |
|---|---|
| 支付方 式 | 支付宝 / 微信 / 银联等 |
| 商户编号 / 商户名称 | 交易归属商户 |
| 门店编号 / 门店名称 | 交易归属门店 |
| 通道名称 | 我方接入的支付通道 |
| 终端号 | 终端设备编号 |
| 支付类型 | 扫码 / 刷卡 / 刷脸等 |
| 创建时间 | 订单创建时间 |
| 结算时间 | 账单归属时间 |
| 商户订单号 | 调用方订单号(outTradeNo) |
| 订单金额 | 下单金额,元 |
| 交易金额 | 实际交易金额,元(退款行为退款金额) |
| 结算金额 | 结算入账金额,元 |
| 费率 | 手续费费率,万分比整数 |
| 手续费 | 交易手续费,元 |
| 订单状态 | 支付成功 / 退款成功 |
| 商户退款单号 | 退款行对应的商户退款单号 |
| 卡类型 | 借记卡 / 贷记卡 |
| 通道订单号 | 通道侧订单号 |
| 通道用户标识 | 通道侧用户 ID |
| 请求流水号 | 我方支付流水号 |
| 订单标题 | 商品/订单描述 |
| 错误码 | 说明 | 处理建议 |
|---|---|---|
| 200 | 成功 | - |
| 12001 | 缺少必填参数 | 检查 billDate/taskId |
| 12002 | 参数格式错误 | billDate 必须为 yyyy-MM-dd |
| 12003 | 账单日期不能晚于当前日期 | 改为已结算日期 |
| 12004 | 账单日期超出可下载范围 | 仅支持近 90 天,更早账单联系平台 |
| 12005 | 应用未关联商户 | 联系平台完成应用与商户绑定 |
| 12101 | 商户不存在 | 核对商户编号 |
| 12102 | 商户类型不支持对账单下载 | 联系平台核实应用商户类型 |
| 12103 | 商户不属于当前应用 | 只能对账本商户或其下挂商户 |
| 12201 | 对账任务不存在 | 核对 taskId,或确认任务由本应用创建 |
| 12202 | 对账文件已超过保留期 | 用同一 billDate 重新调用 4.2.1.1 |
| 12203 | 对账文件下载地址生成失败 | 稍后重试 4.2.1.2,持续失败联系平台 |
| 12999 | 系统内部错误 | 稍后重试 |
status=4 时重新调用 4.2.1.1 会创建新任务;请记录失败时的 billDate 便于排查。status=1 阶段。| 接口编号 | 模块 | 接口路径 | 说明 |
|---|---|---|---|
| 4.2.1.1 | 对账下载 | /v1/open/dump/reconciliation/task/create | 对账单下载任务创建 |
| 4.2.1.2 | 对账下载 | /v1/open/dump/reconciliation/task/get | 对账单下载任务查询 |
| 4.2.1.3 | 对账下载 | /v1/open/dump/reconciliation/task/page | 对账单下载任务分页查询 |
| 提交接口 | 查询接口 | 回调通知 | 说明 |
|---|---|---|---|
| 4.2.1.1(创建对账任务) | 4.2.1.2(task/get) | 不支持 | 需轮询获取下载地址 |
| - | 4.2.1.3(task/page) | 不支持 | 历史任务补偿查询 |
| 枚举 | 说明 | 关键值 |
|---|---|---|
| ExcelExportTaskStatusEnum | 对账任务状态 | 1=等待中, 2=进行中, 3=成功, 4=失败 |
| PayStatusCodeEnum | 账单内订单状态 | 1=支付成功, 5=退款成功(对账单仅含这两类) |
| SbmchMerchantTypeEnum | 应用关联商户类型 | 1=普通商户, 2=代理商户, 3=品牌商户 |