使用授权声明
本文档中所包含的信息属于商业机密信息，应严格控制使用范围，如无宝付网络科技（上海）有限公司（以下简称“宝付”）的书面许可，任何人员不得以任何介质方式持有或使用本文档的部分或全部内容。

文档修订记录

1 文档说明

1.1 文档目的

本文档是为宝付协议支付API产品定义一个接口规范，以帮助商户技术人员快速接入宝付协议支付API网关，并快速掌握其相关功能，便于尽快的投入使用。

1.2 阅读对象

• 商户开发人员、维护人员和管理人员
• 宝付协议支付API产品相关的技术人员

1.3 技术支持

在开发或使用宝付协议支付API接口时，如果您有任何技术上的疑问，请按如下方式寻求帮助，宝付技术支持人员会及时处理，给予您答复：
技术支持热线：021-68819999-8005
技术支持Email：support@baofoo.com
技术支持QQ：800066689

• DEMO下载：

1.4 术语与定义

1.4.1 符号含义

数据类型

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

字符集及编码

报文采用Unicode字符集，UTF-8编码方式。

保留字

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

1.4.2 术语含义

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

1.5 通讯模式

采用HTTPS方式进行通讯。

1.6 报文说明

1.6.1 请求报文

请求报文格式

格式：key1=value1&key2=value2&key3=value3…
例如：send_time=2018-01-24 13:25:33&msg_id=456795112&version=4.0.0.0&terminal_id=100000949&txn_type=03&member_id=100000749&dgtl_envlp=5a9c3ac419735d249e319727c89cfc0ce4a80d6a954980eaf3ea934316a56a121c758b0d13bf3302b877a8dd68619db72b2bd588ccdc9eb7fdb455705be1909df96540009146d7d81c96c0b90578f9344bd3fc00ded94d27c0c8040a83c02114b7a3a4698f830b7d0db60f230a5c3a4b38e7104088f2ee0139a4e765a9d79255&user_id=123&signature=7ca60bdea1f253b1a09588f7e4f0d455d984eaad0a446e61044c1527ea19fbdd70d690cc627327955b7a01a58acbc11cad6a26f8086c1bf23126da36832be59c46bc20e942bcae7614fcd9ba4dc7eec4c5e17024fb04fe5e63f2d137a3517a1e0c7bdea6d4ae33dbab7d20543e474a4bd790f7ba42cacaef45730623482a70ac

签名算法

将除签名字段之外的不为空的字段按key-value的形式构建TreeMap<String, String>对象，按key1=value1&key2=value2…模式将TreeMap对象转换为字符串，UTF-8编码格式下进行SHA-1计算后转换为16进制字节数组，用商户RSA私钥签名后转16进制。

数字信封

生成AES密钥，按照如下拼装：
格式：01|对称密钥，01代表AES算法
加密方式：Base64转码后使用宝付的公钥RSA加密

敏感字段加密

加密方式：Base64转码后，使用数字信封指定的方式和密钥加密

1.6.2 返回报文

返回报文格式

格式：key1=value1&key2=value2&key3=value3…
例如：
biz_resp_code=0000&biz_resp_msg=交易成功&dgtl_envlp=74652829c07a71983c0da582321818aec41364528626e0f90eac1c633755b9dab84593695f5a101401052e9c64d457a881e442206330215de2281d2a3ea15d79e6732e296fdc36c6e0c76d17376cf6b9fc978b50bc747a9536d93226a69aba587f9fa5227a9b2cb915d1b822753f4a86a9fa1d81bf4d106723d927cf0f6365fb&member_id=100000749&msg_id=4a3f0b1862b94b6f853c1d28f9913f82&protocols=f222d7fe76b7c8ea7e22f3ee315e579a4263d697b12de605c287018e15cd530358dd8f638e4211b09e4e250d6b352304e0b454332aa0efda6977d435cf911dbc3943615ae31752e9a87c6e4b69dfc9e3af6be7a9a6e3f6a92a63e65b59936beb&resp_code=S&send_time=2018-01-25 09:53:01&signature=8ab74c7869632dc395cc945adcc388e6afceb759e4d406c3bb6e0e8002ec422f1615f2a43966d7337dcc57963f18877a959fe9f67b082da2cd95217ba003cc81f07962d665f576509ebc1a38f7ddf2a423775a794b262b7ffc4af615da3ba6bd05d0672c004d7cf80be3ed236f268078bb5c700d4b0a6ae9a0e58f2c782bd6ef&terminal_id=100000949&txn_type=03&version=4.0.0.0

验签算法

将宝付返回的除签名字段之外的不为空的字段按key-value的形式构建TreeMap<String, String>对象，按key1=value1&key2=value2…模式将TreeMap对象转换为字符串，UTF-8编码格式下进行SHA-1计算后转换为16进制字节数组。将宝付返回的签名字段转16进制字节数组，用宝付RSA公钥验签。

数字信封解密

解密方式：后使用商户的私钥解密后Base64解码
解密后格式：01|对称密钥，01代表AES算法

敏感字段解密

解密方式：使用数字信封指定的方式和密钥解密后Base64解码

1.7 H5接入

1.7.1 商户服务载体为APP

当商户APP跳转至H5完成相关操作关闭页面时，则需要下述方法：
关闭H5页面：bfCloseH5(str)

1.7.2 商户服务载体为uniapp

当商户跳转H5完成相关操作时，商户根据自身业务场景返回至uniapp页面时，则需要下述方法：
关闭H5页面：参数method：bfCloseH5

接收方法参考：

1.7.3 注意事项

js交互时安卓方法对象名为androidYZH，ios交互方法对象名为nativejs
由于APP载体H5需提供相关权限信息和配置信息，安卓建议如下配置：

wvShop = (WebView) findViewById(R.wv_body);
      wvShop.getSettings().setJavaScriptEnable(true);//允许与js交互
      wvShop.getSettings().setDefaultTextEncodingName("utf-8");//支持中文
      wvShop.addJavaScriptInterface(new JsInterface(this),"androidYZH");//支持调用本地java方法
      wvShop.getSettings().setDomStorageEnable(true);//开启dom，允许缓存（防止白屏）
      wvShop.setWebViewClient(new WebViewClient){
          //覆盖shouldOverrideUrlLoading 方法
          @Override
          public Boolean shouldOverrideUrlLoading(WebView view ,String url){
              if(url == null )
                  return false;
              try{
                  if(url.startWith("http:") || url.startWith("https:")){
                      view.loadurl(url);
                      return true;
                  }else { //如果不是http、https，采用系统浏览器打开
                      Intent intent = new Intent(Intent.ACTION_VIEW,Uri.parse(url));
                      startActivity(intent);
                      return true;
                  }
              }catch (Exception e){ //防止crash
                  return false;
              }
          }
      }

2 业务接口说明

2.1 应用场景

应用场景
宝付协议支付API产品是持卡人在商户平台购买服务或商品时，通过互联网将卡信息和身份信息提供给商户，商户在得到持卡人授权后，委托宝付从银行卡中将相应款项扣除，以满足商户的银行卡支付的业务需求。
组合支付模式，即在协议支付分账模式基础上，上送营销账户出款信息和分账信息，实现银行卡收单和营销账户组合支付后然后进行分账。
订单金额=营销账户金额+银行卡支付金额。
例如 订单100元，营销账户承担金额10 支付成功后：
营销账户支付金额为10
银行卡支付金额为90
注：该接口为后台指令模式

目前银行要求在商户平台页面上挂持卡人与银行之间的服务协议（快捷支付、协议支付），用户在绑卡时需要用户详细阅读并同意协议，才可以提供协议支付服务。各家银行的协议内容不一样，已经放到接口包里。如果不清楚可联系技术支持。银行挂网协议材料点击下载

2.2 业务接口

2.2.1 预绑卡

绑定银行卡是指经过持卡人授权将个人银行卡和商户建立绑定关系，支付时不再需要输入银行卡信息。商户需先进行预绑卡，宝付（或银行）会发送短信验证码（可根据银行要求来配置是否发送）给持卡人，商户再使用确认绑卡接口将短信验证码回传给宝付完成绑卡。

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

2.2.2 确认绑卡

绑定银行卡是指经过持卡人授权将个人银行卡和商户建立绑定关系，支付时不再需要输入银行卡信息。商户需先进行预绑卡，宝付（或银行）会发送短信验证码（可根据银行要求来配置是否发送）给持卡人，商户再使用确认绑卡接口，将短信验证码回传给宝付完成绑卡。

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

2.2.3 直接支付类交易

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

交易子类说明

商户支付时，需根据营销账户全额或订单部分金额，上送不同的交易类型
1、当交易子类（txn_type）为32时，营销账户不能全额出资，
2、当交易子类（txn_type）为50时，营销账户可以全额出资。
全额出资即为订单金额=营销金额。
当交易子类（txn_type）为50时需开通分账-组合营销支付产品

请求报文

返回报文

2.2.4 解除银行卡绑定

解绑是指持卡人发起的银行卡和商户解除绑定关系的业务。

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

2.2.5 绑定结果查询

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

2.2.6 支付结果查询类交易

当系统返回异常或其他原因导致订单状态不明确时，可通过该接口查询订单状态。
当交易请求超时，不建议立即发起查询，建议延后再查询。

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

2.2.7 分账订单状态查询类交易

当分账交易收单成功却没有收到分账成功通知时，可通过该接口查询分账订单状态。

交易URL

测试环境地址：https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址：https://public.baofoo.com/cutpayment/protocol/backTransRequest

请求报文

返回报文

注：该接口响应参数resp_code只会返回S（成功）和F（失败）。F代表接口参数错误或者分账订单不存在。S代表分账订单存在，具体的订单状态和分账状态需要判断order_state和share_state的返回值。

2.2.8 交易结果异步通知

如果直接支付类交易或预绑卡支付时上传了异步通知地址（return_url字段），当订单成功或失败时候会收到宝付的异步通知。
异步通知以GET和POST方式发送到商户配置的接收地址，商户接收到支付结果，并且进行相应处理之后，需要商户接收通知的地址在页面上输出 OK 表示接收成功<除了 OK 无任何其他内容>，告诉宝付已经成功接收并处理完毕，宝付系统在未得到商户接收通知成功的反馈时，将通过重发机制再次通知商户（重发次数 2~10 次，请以第一次收到的支付成功的消息为准，避免进行多次充值或支付），直到商户接收成功或达到最大重发次数为止。
例如：biz_resp_code=0000&biz_resp_msg=交易成功& member_id=100000749 &resp_code=S& trans_id =201803221785&signature=8ab74c7869632dc395cc945adcc388e6afceb759e4d406c3bb6e0e8002ec422f1615f2a43966d7337dcc57963f18877a959fe9f67b082da2cd95217ba003cc81f07962d665f576509ebc1a38f7ddf2a423775a794b262b7ffc4af615da3ba6bd05d0672c004d7cf80be3ed236f268078bb5c700d4b0a6ae9a0e58f2c782bd6ef&terminal_id=100000949& order_id =58752185& succ_amt =585& succ_time =2018-01-24 13:25:33

2.2.9分账结果异步通知

如果直接支付类分账交易上传了分账异步通知地址（share_notify_url字段），当分账成功后会收到宝付的异步通知。
异步通知以GET和POST方式发送到商户配置的接收地址，商户接收到支付结果，并且进行相应处理之后，需要商户接收通知的地址在页面上输出 OK 表示接收成功<除了 OK 无任何其他内容>，告诉宝付已经成功接收并处理完毕，宝付系统在未得到商户接收通知成功的反馈时，将通过重发机制再次通知商户（重发次数 2~10 次，请以第一次收到的支付成功的消息为准，避免进行多次充值或支付），直到商户接收成功或达到最大重发次数为止。
例如：biz_resp_code=BF00338&biz_resp_msg=分账成功&member_id=100000749&resp_code=S&trans_id=201803221785&signature=8ab74c7869632dc395cc945adcc388e6afceb759e4d406c3bb6e0e8002ec422f1615f2a43966d7337dcc57963f18877a959fe9f67b082da2cd95217ba003cc81f07962d665f576509ebc1a38f7ddf2a423775a794b262b7ffc4af615da3ba6bd05d0672c004d7cf80be3ed236f268078bb5c700d4b0a6ae9a0e58f2c782bd6ef&terminal_id=100000949&order_id=58752185

返回报文

返回报文

3 附录

业务应答码

参考业务应答码列表

银行编码

交易类型枚举

商户接口枚举类型

A1、卡类型- card_type

A2、证件类型- id_card_type

商户接口应答码

风控参数字段说明

通用参数

电商

互金消金

航旅

酒店

保险

游戏

大宗

风控参数数据字典

商品类目（prodTypeList）

行业类目（goodsCategory）

证件类型

交易类型（btType）

帐户类型（btAcctType）

国家代码

机场代码

参照国际航空运输协会规定的3位机场代码，国际通用代码，因此每家商户都一致。

省份，区域代码

参照我司省份、区域代码表–>查看下载