⼀、⽂档介绍

1.1 ⽂档⽬的

本⽂主要介绍宝付⼿机银⾏API的需求背景，业务流程，应⽤场景，具体任务等。为开发⼈员、测试⼈员、技术⽀持⼈员提供业务依据和参考

1.2 阅读对象

商户开发⼈员、维护⼈员和管理⼈员
宝付⼿机银⾏产品相关的技术⼈员

1.3 技术⽀持

在开发或使⽤宝付⼿机银⾏接⼝时，如果您有任何技术上的疑问，请按如下⽅式寻求帮助，
宝付技术⽀持⼈员会及时处理，给予您答复：
技术⽀持热线：021-68819999-8005
技术⽀持Email：support@baofoo.com
技术⽀持QQ：800066689

1.4 术语术语与定义

1.4.1 符号含义

序号 符号缩写 符号性质 符号说明
1 M 强制域(Mandatory) 必须填写的属性，否则会被认为格式错误
2 C 条件域(Conditional) 某条件成⽴时必须填写的属性
3 O 选⽤域(Optional) 选填属性
4 R 原样返回域(Returned) 必须与先前报⽂中对应域的值相同的域

数据类型

类型语法：[Max][Min][Size][Type]
Max:可选描述符，如果出现，则说明业务要素的⻓度最⼤为Size
Min:可选描述符，如果出现，则说明业务要素的⻓度最⼩为Size
Size：强制描述符，指定业务要素UTF-8编码前的最⼤字符数。
Type：强制描述符，指定业务要素的类型属性。Type主要属性如下

序号 字段类型Type 符号说明
1 code 编码枚举型数据，具体枚举类型⻅附录：枚举类型
2 Text 字符串
3 Numeric 数字
4 ISODateTime ⽇期时间，格式为 yyyy-MM-dd HH:mm:ss ,如:2017-12-20 21:54:21

字符集及编码

报⽂采⽤Unicode字符集，UTF-8编码⽅式。

保留字

报⽂内容中“|”、“%”、 “#”、 “^”、 “-”等为局部保留字，在相关以此类字符作为分隔符的复合字段中不应出现。

1.4.2 术语含义

商户号：宝付提供给商户的唯⼀编号，是商户在宝付的唯⼀标识；
终端号：商户在与宝付签订某项具体产品功能的合作协议⾃动分配的会员属性，将⽤于进⾏具体交易的必要参数。
商户流⽔号：商户请求宝付时提交的流⽔号，每次请求均不可重复；

1.5 通讯模式

采⽤HTTPS⽅式进⾏通讯。

⼆、业务接⼝说明

2.1 商户下单接⼝

下单是⽤户进⾏⽀付时，进⼊到收银台，⽣成和业务订单对应的⽀付订单
该接⼝公共部分对接请参考⽂档《宝付交易统⼀⼊⼝接⼝⽂档.docx》

交易URL

测试环境地址：https://vgw.baofoo.com/union-gw/api/T-1001-024-01/transReq.do
⽣产环境地址：https://public.baofu.com/union-gw/api/T-1001-024-01/transReq.do

请求报⽂

序号 域名 变量名 必填 字段类型 备注
1 商户号 memberId M Max11Numeric 宝付提供给商户的唯⼀编号
2 终端号 terminalId M Max11Numeric
3 商户订单号 memberTransId M Max30Text 商户流⽔号
4 交易⽇期 tradeDate M MISODateTime 格式：yyyyMMdd HHmmss如20171219201919
5 交易⾦额 orderAmt M Max12Numeric 单位：分 例：1元则提交100
6 交易回调地址 notifyUrl O Max255Text
7 类型 tradeCode M Max1Numeric 0 ⼿机银⾏ 1⼿机银⾏分账
8 请求附加信息 reqAddtion O Max255Text
9 分账信息 shareInfo O Max200Text 格式：分账⽅,分账⾦额tradeCode为1 必传;例：100000082,100;10000083,20
10 分账通知地址 shareNotifyUrl O Max200Text

返回报⽂

序号 域名 变量名 必填 字段类型 备注
1 状态码 retCode M Max1Numeric 1:成功，0:失败,2:异常
2 应答码 errorCode O Max20Numeric
3 应答描述 errorMsg O Max255Text

2.2 获取银⾏列表

下单后向⽤户展示⽀持的银⾏列表, 商户需⾃⼰缓存，有次数限定
该接⼝公共部分对接请参考⽂档《宝付交易统⼀⼊⼝接⼝⽂档.docx》

交易URL

测试环境地址：https://vgw.baofoo.com/union-gw/api/T-1001-024-02/transReq.do
⽣产环境地址：https://public.baofu.com/union-gw/api/T-1001-024-02/transReq.do

请求报⽂

序号 域名 变量名 必填 字段类型 备注
1 商户订单号 memberTransId M Max30Text 商户流⽔号，下单时传的订单号
2 商户号 memberId M Max11Numeric
3 类型 cardType M Max1Numeric 1 借记卡

返回报⽂

序号 域名 变量名 必填 字段类型 备注
1 状态码 retCode M Max1Numeric 1:成功，0:失败,2:异常
2 应答码 errorCode O Max20Numeric
3 应答描述 errorMsg O Max255Text
4 银⾏列表集合 bankList Max255Text

bankList 集合

序号 域名 变量名 必填 字段类型 备注
1 ⽀付⽅式id functionId M Max20Numeric
2 银⾏名称 bankName O

2.3 ⽹银⽀付接⼝

商户选择银⾏，向银⾏进⾏下单，银⾏返回相应的唤醒地址。
该接⼝公共部分对接请参考⽂档《宝付交易统⼀⼊⼝接⼝⽂档.docx》

交易URL

测试环境地址：https://vgw.baofoo.com/union-gw/api/T-1001-024-03/transReq.do
⽣产环境地址：https://public.baofu.com/union-gw/api/T-1001-024-03/transReq.do

请求报⽂

序号 域名 变量名 必填 字段类型 备注
1 商户号 memberId M Max11Numeric 宝付提供给商户的唯⼀编号
2 商户订单号 memberTransId M Max30Text
3 ⽀付⽅式 functionId M Max11Numeric
4 渠道受理⽅式 channelType O Max255Text 受理⽅式： APP、H5, 默认H5
5 ip地址 clientIp M Max15Text

返回报⽂

序号 域名 变量名 必填 字段类型 备注
1 状态码 retCode M Max1Numeric 1:成功，0:失败,2:异常
2 应答码 errorCode O Max20Numeric
3 应答描述 errorMsg O Max255Text
4 宝付订单号 orderId C
5 商户号 memberId R
6 商户订单号 memberTransId R
7 请求地址号 reqUrl C
8 ⽀付订单创建时间 time C
9 调⽤银⾏字符集编码 reqCharset C
10 调⽤银⾏⽅法 reqMethod O
11 请求银⾏参数 reqParams O

2.4 商户订单查询接⼝

商订单查询是⽀付完成后，前端请求后台查询订单状态.
该接⼝公共部分对接请参考⽂档《宝付交易统⼀⼊⼝接⼝⽂档.docx》

交易URL

测试环境地址：https://vgw.baofoo.com/union-gw/api/T-1001-024-04/transReq.do
⽣产环境地址：https://public.baofu.com/union-gw/api/T-1001-024-04/transReq.do

请求报⽂

序号 域名 变量名 必填 字段类型 备注
1 商户号 memberId M Max11Numeric 宝付提供给商户的唯⼀编号
2 商户订单号 memberTransId M Max30Text

返回报⽂

序号 域名 变量名 必填 字段类型 备注
1 状态码 retCode M Max1Numeric 1:成功，0:失败,2:异常
2 应答码 errorCode O Max20Numeric
3 应答描述 errorMsg O Max255Text
4 宝付订单号 orderId C Max20Numeric 订单成功返回
5 商户号 memberId R Max11Numeric
6 商户订单号 memberTransId R Max30Text
7 交易⾦额 orderAmt M Max12Numeric 单位：分；例：1元则提交100 ；订单成功返回
8 ⼿续费 feeAmt C Max12Numeric 单位：分；例：1元则提交100 ；订单成功返回
9 终端号 terminalId M Max11Numeric
10 交易⽇期 tradeDate M ISODateTime 格式：yyyyMMddHHmmss；如20171219201919
11 请求附加信息 reqAddtion O Max255Text 状态：N:订单未⽀付
12 订单状态 orderState M Max1Text P:⽀付处理中；S:⽀付成功；C:交易关闭；F:⽀付失败
13 成功时间 succTime C ISODateTime 交易成功时间：(yyyyMMddHHmmss)订单成功返回

2.5 商户通知接⼝

在宝付处理成功之后，会将交易结果通知到商户。

返回报⽂

序号 域名 变量名 必填 类型 备注
1 商户号 memberId R Max11Numeric 宝付提供给商户的唯⼀编号
2 终端 terminalId R Max11Numeric 由宝付分配
3 加密数 data_content M

加密数据

加密报⽂使⽤请求时候的格式。

序号 域名 变量名 必填 字段类型 备注
1 商户号 memberId R Max11Numeric
2 终端号 terminalId M Max11Numeric
3 商户订单号 memberTransId R Max30Text
4 交易⽇期 tradeDate M ISODateTime 格式：yyyyMMddHHmmss如20171219201919
5 宝付订单号 orderId C Max20Numeric 订单成功返回
6 订单状态 orderState M Max1Text 状态:N:订单未⽀付;P:⽀付处理中;S:⽀付成功;C:交易关闭;F:⽀付失败
7 交易⾦额 orderAmt M Max12Numeric 单位：分;例：1元则提交100 订单成功返回
8 ⼿续费 feeAmt C Max12Numeric 单位：分;例：1元则提交100 ;订单成功返回
9 请求附加信息 reqAddtion O Max255Text
10 成功时间 succTime C ISODateTime 交易成功时间(yyyyMMddHHmmss)订单成功返回

2.6 分账通知接⼝

如果交易的类型是分账模式，在宝付处理分账成功之后，会将分账结果通知到商户的notify_url。

返回报⽂

序号 域名 变量名 必填 备注
1 加密数 data_content M

加密数据

加密报⽂使⽤请求时候的格式。

序号 域名 变量名 必填 字段类型 备注
1 商户号 member_id R Max11Numeric 宝付提供给商户的唯⼀编号
2 终端 terminal_id R Max11Numeric 由宝付分配
3 返回码 resp_code M Max10Text 状态码
4 返回码描述 resp_msg M Max55Text
5 商户订单号 trans_id R Max30Text

三、附录

银⾏功能（bankList）

⽀付⽅式 类型 银⾏名称
4020026 借 中国银⾏
4020002 借 ⼯商银⾏
4020035 借 平安银⾏
4020005 借 农业银⾏
4020001 借 招商银⾏
4020038 借 邮政储蓄银⾏
4020039 借 中信银⾏
4020003 借 建设银⾏
4020006 借 ⺠⽣银⾏

备注:

  • 更多返回错误代码请看⾸⻚的错误代码描述
作者：庞寅  创建时间：2023-06-12 19:44
最后编辑：xiaofeng  更新时间：2024-09-19 18:06