一、文档说明

1.写在前面2.错误代码表

二、安全认证与签名

1.签名方法2.AES加密

三、结算公司和资金余额

1.资金池余额查询2.税源地公司信息查询

四、实时发放

1.接口使用流程2.实时发放数据上报(单笔)3.查询实时发放数据(单笔)4.回调通知5.申请实时发放业务账单6.查询实时发放业务账单申请状态

五、业务级错误代码

1.实时发放接口错误代码2.数据格式正则校验失败code

六、枚举类型

1.证件类型2.支付宝支付交易失败code3.交易状态4.导出状态
5.申请实时发放业务账单

概述:

  • 根据订单创建时间或支付成功时间创建导出任务,导出指定时间段内的发放明细

导出流程分两个步骤:

  1. 使用<申请实时发放业务账单>接口创建申请,并获取fileId
  2. 等待一段时间后,使用file_id请求<查询实时发放业务账单申请状态>接口查询申请信息。单个申请建议每5分钟查询一次状态。月初账单生成较慢,请耐心等待(如订单量过大在月初申请需要等待几个小时)

请求URL:

{{host}}/api/export/transferListExportApply

  • 请求方式:POST
公共请求参数
参数名 必选 类型 说明
plat string 来源,本接口固定值:api
version string 接口版本, 本接口固定值:100000
access_key string 平台分配给商户唯一ID
timestamp int 请求时的时间戳,示例:1625590924
signature string 签名字符串 见签名说明
业务请求参数

Tips:
订单创建时间、支付成功时间可同时填写或二选一,不得全部为空
导出时间范围最长不得超过31天

参数名 必选 类型 说明
createTimeStartTime 与paymentTimeStartTime二选一必填 string 订单创建开始时间
createTimeEndTime createTimeStartTime非空时必填 string 订单创建结束时间
paymentTimeStartTime 与createTimeStartTime二选一必填 string 订单支付成功开始时间
paymentTimeEndTime paymentTimeEndTime非空时必填 string 订单支付成功结束时间
业务响应参数
参数名 类型 说明
code number 状态码
errcode string 错误代码
msg string 信息
data object
data.fileId string 文件申请号fileId信息。使用fileId可以查询处理状态。
响应示例

正常:

{
  "code": 200,
  "msg": "导出成功",
  "data": {
    "fileId": "725"
  }
}

异常:

{
  "code": 500,
  "msg": "订单创建时间、订单成功支付时间不能同时为空",
  "errcode": "REQUIRED_FIELD_NOT_EXIST"
}