1. 文档说明
1.1 文档目的
本文档的目的是为宝付代付定义一个接口规范,以帮助商户技术人员快速接入宝付代付API接口,并快速掌握代付API接口中的相关功能,便于尽快的投入使用。
1.2 阅读对象
- 商户开发人员、维护人员和管理人员
- 宝付代付相关的技术人员
1.3 技术支持
在开发或使用宝付代付白名单接口时,如果您有任何技术上的疑问,请按如下方式寻求帮助,宝付技术支持人员会及时处理,给予您答复:
技术支持热线:021-68819999-8005
技术支持Email:support@baofoo.com
技术支持QQ:800066689
2. 接口须知
2.1 术语定义
符号 | 符号性质 | 符号说明 |
---|---|---|
M | 强制域(Mandatory) | 必须填写的域 |
C | 条件域(Conditional) | 某条件成立时必须填写的域 |
O | 选用域(Optional) | 选填属性(可选预) |
R | 原样返回域(Returned) | 必须与先前报文中对应域的值相同的域 |
2.2 统一入口
请求参数参看统一入口接口文档,本文档中的参数为接口的报文参数。
文档:《统一入口文档》
3. 代付白名单接口
白名单接口需要联系商务经理申请配置后才能商用
3.1 请求地址
参看2.2 统一入口相关说明
3.2 白名单批量添加
3.2.1接口说明
1.报文编号:T-1001-035-01
2.接口用于批量添加代付白名单,添加白名单后商户仅支持对白名单内的银行账户进行代付。
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 商户订单号 | transNo | M | 商户订单号 全局唯一 |
2 | 数据列表 | dataList | M | Max32Text |
dataList属性如下 | 整个字段需要AES加密 | |||
1 | 账户名 | accName | M | |
2 | 卡号 | accNo | M | |
3 | 开户银行 | bankName | C | 对公填写 |
4 | 开户支行名称 | bankDept | C | 对公填写 |
返回报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 响应码 | respCode | M | |
2 | 响应描述 | respMsg | M | |
3 | 宝付批次号 | batchNo | C | 受理成功返回 |
4 | 状态 | status | M | INIT 初始化 PROCESSING 受理成功 SUCCESS 执行完毕(代表批次每笔都处理过,不代表成功) |
示例
请求参数
业务数据结构
{
“transNo”: “TEST_ORDER_1751370962186”,
“dataList”: “加密后的白名单数据列表”
}
dataList白名单数据项结构
注意:此部分数据需要使用数据信封密钥加密后放入dataList字段
[
{
“accName”: “张三”,
“accNo”: “6222011043”,
“bankName”: “中国银行”,
“bankDept”: “北京分行”
},
{
“accName”: “李四”,
“accNo”: “6222020044”,
“bankName”: “建设银行”,
“bankDept”: “上海分行”
}
]
响应参数
成功响应示例
{
“respCode”: “0000”,
“respMsg”: “请求交易成功”,
“status”: “PROCESSING”,
“batchNo”: “a1b2c3d4e5f6789012345678901234ab”
}
失败响应示例
{
“respCode”: “0003”,
“respMsg”: “账号列表中存在重复的账号”,
“status”: “FAIL”
}
3.3 白名单批次查询
3.3.1接口说明
1.报文编号:T-1001-035-02
2.接口用于查询批次执行情况,仅代表此批次执行结果,不代表白名单最终添加状态。
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 商户订单号 | transNo | C | 与批次号二选一 |
2 | 批次号 | batchNo | C | 与商户订单号二选一 |
返回报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 响应码 | respCode | M | |
2 | 响应描述 | respMsg | M | |
3 | 状态 | status | M | INIT 初始化 PROCESSING 受理成功 SUCCESS 执行完毕(代表批次每笔都处理过,不代表成功) |
4 | 批次号 | batchNo | C | |
5 | 商户流水号 | transNo | C | |
6 | 商户号 | memberId | C | |
7 | 数据列表(密文) | dataList | C | 成功返回 |
dataList属性列表 | ||||
1 | 卡号 | accNo | M | |
2 | 户名 | accName | M | |
3 | 状态 | status | M | INIT 初始化 PROCESSING成功 SUCCESS 失败 FAIL |
4 | 响应码 | respCode | M | |
5 | 响应描述 | respMsg | M |
示例
请求参数
业务数据结构
{
“batchNo”: “a1b2c3d4e5f6789012345678901234ab”,
“transNo”: “TEST_ORDER_1751370962186”
}
响应参数
成功响应示例
{
“respCode”: “0000”,
“respMsg”: “请求交易成功”,
“status”: “SUCCESS”,
“batchNo”: “a1b2c3d4e5f6789012345678901234ab”,
“transNo”: “TEST_ORDER_1751370962186”,
“memberId”: 100000178,
“detailList”: “加密后的明细列表数据”
}
未找到批次信息响应示例
{
“respCode”: “0701”,
“respMsg”: “未找到对应的批次信息”,
“status”: “FAIL”
}
明细列表结构(解密后)
[
{
“accName”: “张三”,
“accNo”: “421421312321”,
“status”: “SUCCESS”,
“respCode”: “0000”,
“respDesc”: “操作成功”
},
{
“accName”: “李四”,
“accNo”: “41232103921”,
“status”: “FAIL”,
“respCode”: “0701”,
“respDesc”: “业务处理失败”
}
]
3.4 白名单账户信息查询
3.4.1接口说明
1.报文编号:T-1001-035-03
2.接口用于查询白名单账户信息
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 账号 | accNo | O | 需要加密 |
2 | 户名 | accName | O | 需要加密 |
返回报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 响应码 | respCode | M | |
2 | 响应描述 | respMsg | M | |
3 | 总数量 | totalCount | M | |
4 | 数据列表(密文) | dataList | C | 成功返回 |
dataList属性列表 | ||||
1 | 卡号 | accNo | M | |
2 | 户名 | accName | M | |
3 | 开户银行 | bankName | M | |
4 | 开户支行名称 | bankDept | C | 对公返回 |
5 | 状态 | state | M | 1 启动 0 禁用(删除后为禁用状态) |
示例
请求参数
业务数据结构
{
“accName”: “加密后的开户人姓名”,
“accNo”: “加密后的银行卡号”
}
响应参数
成功响应示例
{
“respCode”: “0000”,
“respMsg”: “请求交易成功”,
“totalCount”: 2,
“dataList”: “加密后的查询结果列表”
}
查询失败响应示例
{
“respCode”: “0701”,
“respMsg”: “查询白名单失败”,
“totalCount”: 0
}
查询结果列表结构(解密后)
[
{
“accName”: “张三”,
“accNo”: “41234312432”,
“bankName”: “中国银行”,
“bankDept”: “北京分行”,
“state”: 1
},
{
“accName”: “李四”,
“accNo”: “53215134132”,
“bankName”: “建设银行”,
“bankDept”: “上海分行”,
“state”: 1
}
]
3.5 删除白名单账户信息
3.5.1接口说明
1.报文编号:T-1001-035-04
2.接口用于删除白名单账户信息
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 账号 | accNo | M | 需要加密 |
2 | 户名 | accName | M | 需要加密 |
返回报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 响应码 | respCode | M | |
2 | 响应描述 | respMsg | M | |
3 | 状态 | state | M | SUCCESS 成功 FAIL 失败 |
示例
请求参数
业务数据结构
{
“accName”: “加密后的开户人姓名”,
“accNo”: “加密后的银行卡号”
}
响应参数
成功响应示例
{
“respCode”: “0000”,
“respMsg”: “请求交易成功”,
“status”: “SUCCESS”
}
失败响应示例
{
“respCode”: “0701”,
“respMsg”: “删除白名单失败”,
“status”: “FAIL”
}
附录
注意事项
1.数据加密:所有敏感数据(姓名、卡号、数据列表)必须加密传输
2.重复检查:同一批次内不允许重复的账号
3.银行信息:对公卡必须填写银行名称和开户支行
4.异步处理:添加白名单为异步处理,需要通过批次查询接口获取最终结果