宝付网络科技(上海)有限公司
2024年04月01日 定制
1.文档说明
1.1、文档目的
本文档为宝付资金付款交易接口规范,以帮助商户技术人员快速接入银行账户功能,并快速掌握其相关功能,便于尽快的投入使用。
1.2、阅读对象
商户开发人员、维护人员和管理人员
1.3、技术支持
在开发或使用本接口时,如果您有任何技术上的疑问,请按如下方式寻求帮助,宝付技术支持人员会及时处理,给予您答复:
技术支持热线:021-68819999-8005
技术支持Email:support@baofoo.com
技术支持QQ:800066689
2.接口须知
2.1、术语定义
序号 | 符号缩写 | 符号性质 | 符号说明 |
---|---|---|---|
1 | M | 强制域(Mandatory) | 必须填写的属性,否则会被认为格式错误 |
2 | C | 条件域(Conditional) | 某条件成立时必须填写的属性 |
3 | O | 选用域(Optional) | 选填属性 |
4 | R | 原样返回域(Returned) | 必须与先前报文中对应域的值相同的域 |
2.2、返回码说明
当header的 sysRespCode 为S_0000时,body的retCode如下:
retCode=1 说明接口调用成功。具体业务是否成功。看具体的参数字段。
retCode=0 说明接口调用失败。异常或者参数校验失败。
retCode=2 说明接口调用处理中。需要调用查询接口查询状态。
当header的 sysRespCode 为非S_0000时,系统异常或者校验失败。和具体业务无关联。
3.资金同名对公代付接口
3.1、接口说明
1.接口用于实现商户同名对公电子账户资金代付,商户调用此接口,支持将电子账户划拨至宝付账户后代付至目标电子户。基于一定配置,支持划拨其他关联方银行账户资金至指令方宝付账户后,最终代付至目标银行卡
2.该接口为异步请求。
3.最终状态需要等待通知或者调用查询接口。
4.网络异常未收到报文,请调用查询接口。
5.当status 为SUCCESS时,状态为成功表示受理成功,不代表订单最终状态为成功。
6.当status 为PROCESSING时,表示代付处理中,需要调用查询接口查询或者等待通知。
7.当status 为FAIL时,表示代付失败。
8.errorCode = BF0001 为参数校验失败
9.errorCode = BF0005 为系统异常。
10.errorCode = BF0013 商户订单号已存在,请勿重复提交
3.2、请求报文说明
参数名称 | 类型 | 长度 | 出现要求 | 参数备注 |
---|---|---|---|---|
version | String | 5 | M | 版本号4.0.0 |
requestNo | String | [1,32] | M | 请求流水号 |
memberId | String | [1,32] | M | 商户号 |
balanceAcctId | String | [1,32] | C | 付款方电子户账号 |
accountType | String | [1,32] | O | 付款方电子户类型,默认SSQY(苏商企业号) HT(华通) SN(苏商银行) |
shareMemberId | String | [1,32] | O | 付款方电子户归属商户号 (实际付款方电子户开通时对应的商户号,如不传则宝付默认取memberId进行校验) |
amount | String | [1,32] | M | 付款金额,单位分 |
accName | String | [1,32] | O | 收款方姓名(若不传则默认取同名华通电子户信息,若传则判断商户下是否有此同名电子户) |
accNo | String | [1,32] | O | 收款方卡号(规则同上) |
bankName | String | [1,32] | O | 收款方银行名称(规则同上) |
proName | String | [1,32] | O | 收款方开户省名(规则同上) |
cityName | String | [1,32] | O | 收款方开户市名(规则同上) |
accDept | String | [1,32] | O | 收款方开户行机构名(规则同上) |
transCnap | String | [1,32] | O | 联行号(规则同上) |
noticeUrl | String | [1,255] | O | 异步通知地址(主动推送订单结果) |
summary | String | [1,255] | O | 摘要 |
补充说明
字段名 | 对公 |
---|---|
bankName | bankName和transCnap 二选一 |
proName | proName和transCnap 二选一 |
cityName | cityName和transCnap 二选一 |
accDept | accDept和transCnap 二选一 |
3.3、返回报文说明
参数名称 | 类型 | 长度 | 出现要求 | 参数备注 |
---|---|---|---|---|
retCode | int | 4 | M | 返回码 |
errorCode | String | 20 | C | 错误码 |
errorMsg | String | 40 | C | 错误原因 |
back1 | String | 64 | O | 备用字段 |
back2 | String | 64 | O | 备用字段 |
back3 | String | 100 | O | 备用字段 |
requestNo | BigDecimal | [1,32] | O | 请求流水号 |
status | BigDecimal | [1,32] | O | 状态 SUCCESS:成功 PROCESSING:处理中 FAIL:失败 |
memo | BigDecimal | [1,32] | O | 备注 |
响应报文判断结构
{
header.sysRespCode:S_0000(请求正常,继续查看body)
body.retCode:1
body.status = SUCCESS (成功)
body.status = FAIL (失败)
body.status = PROCESSING (处理中)
body.retCode:0|2
body.errorCode = BF0001 (失败)
body.errorCode = 其他错误码 (异常,调用查询接口)
header.sysRespCode:S_E_9002(未知,调用查询接口)
header.sysRespCode:其他错误码(失败)
}
3.4、异步通知
代付订单最终交易状态以代付state为准
宝付返回格式为XML
商户接收到通知后务必在接收通知页面上返回大写OK
通知格式示例: https://www.baofu.com/notify?member_id=100000178&terminal_id=80226&data_type=XML&data_content=66b4deb%E2%80%A6
注意:
宝付系统在未确认商户接收通知成功后将会通过重发机制通知商户(重发次数10次,请以第一次收到的付款成功的消息为准,避免进行多次确认)通知发给商户。
该接口除了订单成功、失败结果通知外,退款的结果也一并通知。
商户若需要该回调接口需联系技术支持人员配置回调地址等相关信息。
参数名称 | 描述 | 出现要求 | 参数备注 |
---|---|---|---|
trans_orderid | 宝付订单号 | O | 宝付订单号 |
trans_batchid | 宝付批次号 | O | 请求流水号 |
trans_no | 商户订单号 | M | |
trans_money | 交易金额 | M | 单位:元 |
to_acc_name | 收款方姓名 | M | 收款方姓名 |
to_acc_no | 收款方银行帐号 | M | 收款方银行帐号 |
trans_fee | 交易手续费 | M | 交易手续费 |
status | 交易处理状态 | M | 0:转账中;1:转账成功;-1:转账失败;2:转账退款 |
trans_remark | 备注(错误信息) | O | 备注 |
trans_starttime | 交易申请时间 | O | yyyyMMddHHmmss |
trans_endtime | 交易完成时间 | O | yyyyMMddHHmmss |
trans_reserved | 用途 | O | 用途 |
4.资金同名对公代付查询
4.1、接口说明
1.报文编号:T-1001-007-13
2.接口用于查询商户银行账户资金划拨结果
3.接口为同步接口
errorCode = BF0001 为参数校验失败
errorCode = BF0005 为系统异常
errorCode = BF00226 订单不存在
4.当status 为SUCCESS时,表示划拨转账成功。
5.当status 为PROCESSING时,表示划拨转账处理中。
6.当status 为FAIL时,表示划拨转账失败。
4.2、请求报文说明
参数名称 | 类型 | 长度 | 出现要求 | 参数备注 |
---|---|---|---|---|
version | String | 5 | M | 版本号4.0.0 |
memberId | String | [1,32] | M | 商户号 |
requestNo | String | [1,32] | M | 请求流水号 |
4.3、返回报文说明
参数名称 | 类型 | 长度 | 出现要求 | 参数备注 |
---|---|---|---|---|
retCode | int | 4 | M | 返回码 |
errorCode | String | 20 | C | 错误码 |
errorMsg | String | 40 | C | 错误原因 |
back1 | String | 64 | O | 备用字段 |
back2 | String | 64 | O | 备用字段 |
back3 | String | 100 | O | 备用字段 |
requestNo | BigDecimal | [1,32] | O | 请求流水号 |
status | BigDecimal | [1,32] | O | 状态 SUCCESS:成功 PROCESSING:处理中 FAIL:失败 |
memo | BigDecimal | [1,32] | O | 备注 |
响应报文判断结构
{
header.sysRespCode:S_0000(请求正常,继续查看body)
body.retCode:1
body.status = SUCCESS (成功)
body.status = FAIL (失败)
body.status = PROCESSING (处理中)
body.retCode:0|2
body.errorCode = BF00226 (订单不存在,失败)
其他错误码重新发起查询
header.sysRespCode:S_E_9002(重新发起查询)
header.sysRespCode:其他错误码(重新发起查询)
}
5.注意事项
初次使用请仔细核对信息是否有误,出现错误请及时联系宝付技术人员。
附录
1、返回码
retCode | 说明 |
---|---|
1 | 成功 |
0 | 失败 |
2 | 处理中 |
2、证件图片类型
qualType | 说明 |
---|---|
101 | 法人身份证(正) |
102 | 法人身份证(反) |
103 | 税务登记证 |
104 | 营业执照证 |
105 | 组织机构代码证 |
401 | 银行开户许可证 |
3、宝付统一入口
https://docs.baofu.com/docs/interface_document/unionGwAPI
最后编辑:xiaofeng 更新时间:2025-06-04 11:24