- 1 文档说明
- 1.1 文档目的
- 1.2 阅读对象
- 1.3 技术支持联系方式
- 1.4 术语与定义
- 1.4.1 符号含义
- 1.4.2 术语含义
- 1.5 通讯模式
- 1.6 报文说明
- 1.6.1 请求报文
- 1.6.2 返回报文
- 1.7 H5接入
- 商户服务载体为APP
- 商户服务载体为uniapp
- 注意事项
- 1.8 一键绑卡DEMO下载
- 2 业务接口说明
- 2.1 应用场景
- 场景1:商户在自身收银台页面选择银行
- 场景2:商户跳转宝付页面选择银行
- 2.2 业务接口
- 2.2.1 预签约申请
- 请求报文
- 返回报文
- 2.2.2 一键绑卡签约
- 请求报文
- 2.2.3 一键绑卡商户跳转
- 请求报文
- 返回报文
- 2.2.4 历史签约结果查询
- 请求报文
- 返回报文
- 2.2.5网关签约流水结果查询
- 请求报文
- 返回报文
- 2.2.6异步结果通知
- 异步结果通知
- 3 应答码
- 3.1商户接口应答码
- 3.2 宝付业务应答码
- 4 数据元类型说明
- A1交易类型
- A2卡类型- card_type
- A3证件类型- id_card_type
- A4银行编码
- 5 风控参数字段说明
- 通用参数
- 风险信息域risk_info
- 国家代码
- 机场代码
- 省份,区域代码
1 文档说明
1.1 文档目的
本文档是为宝付一键绑卡产品定义一个接口规范,以帮助商户技术人员快速接入宝付一键绑卡网关,并快速掌握其相关功能,便于尽快的投入使用。
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方式进行通讯。
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接入
商户服务载体为APP
当商户APP跳转至H5完成相关操作关闭页面时,则需要下述方法:
关闭H5页面:bfCloseH5(str)
商户服务载体为uniapp
当商户跳转H5完成相关操作时,商户根据自身业务场景返回至uniapp页面时,则需要下述方法:
关闭H5页面:参数method:bfCloseH5
接收方法参考:
uni.postMessage(OBJECT)
网页向应用发送消息,在的message事件回调event.detail.data中接收消息。
注意事项
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;
}
}
}
1.8 一键绑卡DEMO下载
Demo版本 | 更新日期 | 下载链接 |
---|---|---|
JAVA版 | 2024-11-22 | 点击下载 |
.NET版 | 2024-11-22 | 点击下载 |
PHP版 | 2024-11-22 | 点击下载 |
目前银行要求在商户平台页面上挂持卡人与银行之间的服务协议(快捷支付、协议支付),用户在绑卡时需要用户详细阅读并同意协议,才可以提供协议支付服务。如果不清楚可联系宝付技术支持。一键绑卡挂网协议点击下载
2 业务接口说明
2.1 应用场景
宝付一键绑卡产品是持卡人在经过实名认证的商户平台使用银行卡购买服务或商品前,通过互联网将身份信息提供给商户,商户在得到持卡人授权后,委托宝付跳转至银行端页面,持卡人在银行端页面选择银行卡并授权绑卡的过程,以满足持卡人在商户端使用银行卡支付的业务需求。
场景1:商户在自身收银台页面选择银行
商户在自身收银台页面设计选择银行和借贷记卡的交互,用户在商户页面选择银行和借贷记卡后,直接跳转银行。
商户直跳银行页面模式下,商户获取SN(token)后,直接请求宝付后由宝付转跳转银行页面。
流程图:
调用交易子类说明
场景步骤 | 场景步骤调用交易子类 |
---|---|
获取SN(toekn) | |
跳转宝付页面 |
场景2:商户跳转宝付页面选择银行
商户收银台只设计一键绑卡入口,然后跳转宝付页面,用户在选择银行和借贷记卡的交互在宝付页面完成,在宝付页面选择后再跳转银行。
商户直跳银行页面模式下,商户获取SN(token)后,请求宝付后会跳转宝付页面,在宝付页面选择银行和银行卡借贷记后跳转银行页面。
流程图:
调用交易子类说明
场景步骤 | 场景步骤调用交易子类 |
---|---|
获取SN(toekn) | |
跳转宝付页面 |
2.2 业务接口
2.2.1 预签约申请
交易URL
测试环境地址:https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址:https://public.baofoo.com/cutpayment/protocol/backTransRequest
请求报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 报文流水号 | msg_id | M | Max32Text | 商户流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 终端号 | terminal_id | M | Max11Numeric | |
5 | 交易类型 | txn_type | M | code | 固定值(见附录:交易类型枚举) |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES加密方式:Base64转码后使用宝付的公钥加密 |
8 | 用户ID | user_id | O | Max50Text | 用户在商户平台唯一ID |
9 | 银行编号 | bank_code | C | Max10Text | 银行编号,交易类型为79时必填 |
10 | 卡类型 | card_type | C | code | 见附录:枚举类型,交易类型为79时必填 |
11 | 证件类型 | id_card_type | M | code | 见附录:枚举类型 |
12 | 账户信息 | acc_info | M | Max200Text | 格式:持卡人姓名|证件号|手机号(手机号非必传) 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
13 | 页面返回地址 | page_url | M | Max255Text | 签约完成,页面跳转地址,注:地址后不能带参数,带参可能导致银行无法解析 |
14 | 签约结果通知地址 | return_url | M | Max255Text | 宝付后台异步通知,在此签约结果处理,不可使用页面返回地址作为签约结果通知地址 |
15 | 风控参数字段 | risk_item | M | 不限制 | Json格式,详细参数见风控参数字段说明(通用参数、电商、互金消金、航旅、酒店、宝信、游戏、大宗) |
16 | 商户保留域1 | req_reserved1 | O | Max255Text | |
17 | 商户保留域2 | req_reserved2 | O | Max255Text | |
18 | 系统保留域1 | additional_info1 | O | Max255Text | |
19 | 系统保留域2 | additional_info2 | O | Max255Text | |
20 | 签名域 | signature | M | Max512Text | |
21 | 验签方式 | verify_type | O | Max20Text | 示例值:10;国密此字段必传 |
22 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
23 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
- 说明
1) “交易类型”
“交易类型”为请求交易时的交易识别码,该码会直接影响后续交易的交互,请谨慎选择。
“ 预签约申请”接口中“交易类型”与“一键绑卡签约”接口中“交易类型”成对出现,即“79”对应“80”,“81”对应“82”。
具体说明参考:“A1交易类型”。
“79”与“80”为后台模式,“81”与“82”为前台模式。
后台模式下需要商户自行在收银台放置银行和宝付相关协议,前台模式下可不放时银行及宝付相关协议。
2)“银行编号”
“银行编号”在“交易类型”为“79”时,为必传。在“交易类型”为“81”时,如上传则在宝付页面显示上传的银行,如不传则在宝付页面显示所有可选择的银行。
3)“卡类型”
“卡类型”在“交易类型”为“79”时,为必传。在“交易类型”为“81”时,如上传则在宝付页面显示上传的卡类型,如不传则在宝付页面显示所有可选择的卡类型(不限制卡类型则该字段为空)。
4)“签名方式”
“签名方式”用于标识算法方式,国密方式取值为:10;国际算法可默认不传。默认不传为国际算法。
5)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时,必须上传,在“签名方式”为国际算法时,可传可不传。
返回报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 应答报文流水号 | msg_id | M | Max32Text | 宝付的流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 应答码 | resp_code | M | 参见商户接口应答码 | |
5 | 终端号 | terminal_id | M | Max11Numeric | |
6 | 交易类型 | txn_type | M | code | 固定值(见附录:交易类型枚举) |
7 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | Max11Numeric | 具体参见附录1:业务应答码 |
9 | 业务返回说明 | biz_resp_msg | M | Max11Numeric | |
10 | url地址 | url | M | Max512Text | 一键绑卡签约请求地址 |
11 | 预签约唯一码 | token | M | Max255Text | token有效期10分钟,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
12 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES加密方式:Base64转码后使用宝付的公钥加密 |
13 | 商户保留域1 | req_reserved1 | O | Max255Text | |
14 | 商户保留域2 | req_reserved2 | O | Max255Text | |
15 | 系统保留域1 | additional_info1 | O | Max255Text | |
16 | 系统保留域2 | additional_info2 | O | Max255Text | |
17 | 签名域 | signature | M | Max512Text | |
18 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
19 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
-说明
1)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时必返回,在“签名方式”为国际算法时如请求时上送则返回。
2.2.2 一键绑卡签约
交易URL
测试环境地址:一键绑卡预申请中返回的url地址
正式环境地址:一键绑卡预申请中返回的url地址
请求报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 交易类型 | txn_type | M | code | 固定值 (见附录:交易类型枚举) |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 预签约唯一码 | token | M | Max255Text | 明文上送 |
- 说明
1)“交易类型”
在“预签约申请”中“交易类型”为“79”时,此处“交易类型”为“80”。
在“预签约申请”中“交易类型”为“81”时,此处“交易类型”为“82”。
2.2.3 一键绑卡商户跳转
交易URL
测试环境地址:https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址:https://public.baofoo.com/cutpayment/protocol/backTransRequest
请求报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 报文流水号 | msg_id | M | Max32Text | 商户流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 终端号 | terminal_id | M | Max11Numeric | |
5 | 交易类型 | txn_type | M | code | 固定值90 (见附录:交易类型枚举) |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 数字信封 | dgtl_envlp | M | Max512Text | 格式一:01|对称密钥,01代表AES。加密方式:Base64转码后使用宝付的公钥加密 格式二:02|对称密钥,02代表SM4。加密方式:用宝付SM2加密证书公钥加密后转16进制大写 |
8 | 用户ID | user_id | O | Max50Text | 用户在商户平台唯一ID |
9 | 银行编号 | bank_code | M | Max10Text | 银行编号,交易类型为90时必填 |
10 | 卡类型 | card_type | M | code | 见附录:枚举类型,交易类型为90时必填 |
11 | 证件类型 | id_card_type | M | code | 见附录:枚举类型 |
12 | 账户信息 | acc_info | M | Max200Text | 格式:持卡人姓名|证件号。 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
13 | 页面返回地址 | page_url | M | Max255Text | 签约完成,页面跳转地址,注:地址后不能带参数,带参可能导致银行无法解析 |
14 | 签约结果通知地址 | return_url | M | Max255Text | 宝付后台异步通知,在此签约结果处理,不可使用页面返回地址作为签约结果通知地址 |
15 | 风控参数字段 | risk_item | M | Max255Text | Json格式,详细参数见风控参数字段说明(通用参数、电商、互金消金、航旅、酒店、宝信、游戏、大宗) |
16 | 商户保留域1 | req_reserved1 | O | Max255Text | |
17 | 商户保留域2 | req_reserved2 | O | Max255Text | |
18 | 签名域 | signature | M | Max512Text | |
19 | 验签方式 | verify_type | M | Max20Text | RSA:11 ;国密SM2: 10 |
20 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
21 | 签名证书序列号 | sign_sn | O | Max20Text | 发送方公钥证书序列号 |
返回报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 应答报文流水号 | msg_id | M | Max32Text | 宝付的流水号 |
3 | 报文编号/版本号 | version | R | Max7Text | 4.0.0.0 |
4 | 应答码 | resp_code | M | 参见商户接口应答码 | |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | code | 固定值(见附录:交易类型枚举) |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | Max11Numeric | 具体参见附录1:业务应答码 |
9 | 业务返回说明 | biz_resp_msg | M | Max11Numeric | |
10 | 跳转地址 | url | M | Max1000Text | 提交跳转地址 |
11 | 编码类型 | encoding | M | Max10Text | UTF-8 |
12 | 提交方法 | method | M | Max10Text | POST |
13 | 提交参数 | params | M | Max1000Text | 提交参数,json列表格式 |
14 | 数字信封 | dgtl_envlp | M | Max512Text | 格式一:01|对称密钥,01代表AES。加密方式:Base64转码后使用宝付的公钥加密 格式二:02|对称密钥,02代表SM4。加密方式:用宝付SM2加密证书公钥加密后转16进制大写 |
15 | 商户保留域1 | req_reserved1 | R | Max255Text | |
16 | 商户保留域2 | req_reserved2 | R | Max255Text | |
17 | 签名域 | signature | M | Max512Text | |
18 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
19 | 签名证书序列号 | sign_sn | O | Max20Text | 发送方公钥证书序列号 |
-说明
1)提交参数对象:
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 参数名称 | key | M | Text | |
2 | 参数值 | value | M | Text |
params返回示例:
[{“key”:”epccGwMsg”,”value”:”PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48cm9vdCB4bWxucz0ibmFtZXNwYWNlX3N0cmluZyI+PE1zZ0hlYWRlcj48U25kRHQ+MjAyNC0xMi0wNVQxNDoxODo0MjwvU25kRHQ+PE1zZ1RwPmVwY2MuMTA1LjAwMS4wMTwvTXNnVHA+PElzc3JJZD5HNDAwMDMxMTAwMDAxODwvSXNzcklkPjxEcmN0bj4yMTwvRHJjdG4+PFNpZ25TTj40NDAyMzgyODIxPC9TaWduU04+PE5jcnB0blNOPjQyNzU4MTQ1ODc8L05jcnB0blNOPjxEZ3RsRW52bHA+TUlHTkFpRUFoMnkxZ2V6R3hlNTN5K2YzUXFEN3pzQTV2VnRYVFJxc0paUjgwemlpUnJvQ0lRQ0dTVWp2REtadTVjMXBsMFRET0VsaGN1eC9PeGZkU3ZXb1pWRHR6dVAvU1FRZ0Y2K0tvL3I4clg1dWVtRVJpUzRQbzQyZEIwbit2allwM2w2WEhqdEcvZzhFSS9nZDliNExUNlRkbkQzdHdtZjJJRHFuUEtLZXNiQ2Qva2dsL1FMZkRkRWcxNHpXPC9EZ3RsRW52bHA+PC9Nc2dIZWFkZXI+PE1zZ0JvZHk+PFN5c1J0bkluZj48U3lzUnRuQ2Q+MDAwMDAwMDA8L1N5c1J0bkNkPjxTeXNSdG5EZXNjPuaIkOWKnzwvU3lzUnRuRGVzYz48U3lzUnRuVG0+MjAyNC0xMi0wNVQxNDoxODo0MjwvU3lzUnRuVG0+PC9TeXNSdG5JbmY+PEJpekluZj48VHJ4Q3RneT4wMjAwPC9UcnhDdGd5PjxUcnhJZD4yMDI0MTIwNTEwMDAwMDAwMDAxNDkzNjMwMjEwOTAzPC9UcnhJZD48Qml6U3RzQ2Q+MDAwMDAwMDA8L0JpelN0c0NkPjxCaXpTdHNEZXNjPuaIkOWKnzwvQml6U3RzRGVzYz48UmRyY3RVcmw+aHR0cHM6Ly93YXAuY2diY2hpbmEuY29tLmNuL2g1LW1vYmlsZWJhbmstYXBwL3Nlc3Npb24vdW5pb25wYXkvdGhpcmRiaW5kLmxneDwvUmRyY3RVcmw+PC9CaXpJbmY+PFNlYz5aV1lBa3RCZXhHZ3JlVHFWcW1ZTXkyNnNOUzFwQlEvNUFLR0pFMW9JaFJyWHJTZ3dOanJqU3IyMDA5bmNqbTJ5WU8ra2gvOUFrOG1HckZJK1B0Q1RBd2cvRm83SW1RKzB1MjZiSm5YTXpoOXV6S0dVK3BDby9IV0o2YmhHb2I2MCtFOUZwV2JCTktTalNHYVdBTE9PRllaQjJTdkNrNzdOYk9iYlRpUFNrSG9XZm9JbEE1Q0dPemRFRndCMEh2YzZ2T2l1Rlgxc0k2bXR4VzlVVTdlamNMRm1ZazBITkYwTE1QRzBuUjF4a3J3aVNPczBraWQ5c2FUeTVCbVRBUzc3WVpEN2srM0Y5bDBDWlV3QnNyTUN5bVl6V0JSMC9KQzBpSlhVOFhVNW9OWGhPNW5Wa1N4amt5VVFoTVdXWTE3U1huWk9BQjhGbW93RVhrRXVBMHViYXFBZzIvZmVrTGxaWWZEYjU1TDZCV0dLWDBWYUY5eDJUaEpFTGp4bzBFSTllekM0aHVjUHZjZnVRUWZhbDJlbE1aWFJnWEppWG14QTJYT0xUL0lTaHY3ZnBhT0pUemZuaTZzbEJSTkRhZmJMaVpQcEZSMUxkMzFWclpFUVZUYm9rOGdCM0tibGtVY0dyVjJ2Zml2QTBxZEMweWtIQXZtZFBPUlRpU2VpNUlLcWxQWkdhaDRYeTQ2eG5zUTVJRG9URUFOQ3M3VDBWOVY4QkNoUElpQkwvL3VIOVBvaXBzVHZRYjgvZzNBY3J0eGtvNmhtL3JZQm5PUGFzcSswTTVDallBPT08L1NlYz48L01zZ0JvZHk+PC9yb290Pg0Ke1M6TUVZQ0lRRDhnS2IvMUFKbWgvVVZ4YURBUjZKcXlMbk91K25LNzJhKzBsMkhsaklEU0FJaEFMRFVZQzJqWldFLysrYzFiVC9DY203REUyNFpCSXJ5bkxZOFV5bm5DL0hOfQ==”}]
2.2.4 历史签约结果查询
交易URL
测试环境地址:https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址:https://public.baofoo.com/cutpayment/protocol/backTransRequest
请求报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 报文流水号 | msg_id | M | Max32Text | 商户流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 终端号 | terminal_id | M | Max11Numeric | |
5 | 交易类型 | txn_type | M | code | 固定值:03(见附录:交易类型枚举) |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES加密方式:Base64转码后使用宝付的公钥加密 |
8 | 用户ID | user_id | C | Max50Text | 用户在商户平台唯一ID |
9 | 银行卡号 | acc_no | C | Max20Text | 与user_id必须其中一个有值, 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
10 | 商户保留域1 | req_reserved1 | O | Max255Text | |
11 | 商户保留域2 | req_reserved2 | O | Max255Text | |
12 | 系统保留域1 | additional_info1 | O | Max255Text | |
13 | 系统保留域2 | additional_info2 | O | Max255Text | |
14 | 签名域 | signature | M | Max512Text | |
15 | 验签方式 | verify_type | O | Max20Text | 示例值:10;国密此字段必传 |
16 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
17 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
-说明
1)“签名方式”
“签名方式”用于标识算法方式,国密方式取值为:10;国际算法可默认不传。默认不传为国际算法。
2)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时,必须上传,在“签名方式”为国际算法时,可传可不传。
返回报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 应答报文流水号 | msg_id | M | Max32Text | 宝付流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 应答码 | resp_code | M | Max16Text | 具体参见附录:商户接口应答码 |
8 | 业务返回码 | biz_resp_code | M | Max11Numeric | 具体参见附录1:业务应答码 |
9 | 业务返回说明 | biz_resp_msg | M | Max11Numeric | |
10 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES 加密方式:Base64转码后使用宝付的公钥加密 |
11 | 商户保留域1 | req_reserved1 | O | Max255Text | |
12 | 商户保留域2 | req_reserved2 | O | Max255Text | |
13 | 系统保留域1 | additional_info1 | O | Max255Text | |
14 | 系统保留域2 | additional_info2 | O | Max255Text | |
15 | 协议列表 | protocols | M | Max1024Text | 格式:签约协议号|用户ID|银行卡号|银行编码|银行名称; 签约协议号|用户ID|银行卡号|银行编码|银行名称; 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
16 | 签名域 | signature | M | Max512Text | |
17 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
18 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
-说明
1)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时必返回,在“签名方式”为国际算法时如请求时上送则返回。
2.2.5网关签约流水结果查询
交易URL
测试环境地址:https://vgw.baofoo.com/cutpayment/protocol/backTransRequest
正式环境地址:https://public.baofoo.com/cutpayment/protocol/backTransRequest
请求报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
3 | 报文流水号 | msg_id | M | Max32Text | 商户流水号 |
4 | 原报文流水号 | orig_msg_id | M | Max32Text | 原商户预签约流水号 |
5 | 交易类型 | txn_type | M | code | 固定值:78(见附录:交易类型枚举) |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 终端号 | terminal_id | M | Max11Numeric | |
8 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES 加密方式:Base64转码后使用宝付的公钥加密 |
9 | 商户保留域1 | req_reserved1 | O | Max255Text | |
10 | 商户保留域2 | req_reserved2 | O | Max255Text | |
11 | 系统保留域1 | additional_info1 | O | Max255Text | |
12 | 系统保留域2 | additional_info2 | O | Max255Text | |
13 | 签名域 | signature | M | Max512Text | |
14 | 验签方式 | verify_type | O | Max20Text | 示例值:10;国密此字段必传 |
15 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
16 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
-说明
1)“签名方式”
“签名方式”用于标识算法方式,国密方式取值为:10;国际算法可默认不传。默认不传为国际算法。
2)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时,必须上传,在“签名方式”为国际算法时,可传可不传。
返回报文
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 应答报文流水号 | msg_id | M | Max32Text | 宝付流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 应答码 | resp_code | M | Max16Tex | 具体参见附录:业务应答码 |
5 | 终端号 | terminal_id | M | Max11Numeric | |
6 | 交易类型 | txn_type | M | code | 固定值:81(见附录:交易类型枚举) |
7 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 签约协议号 | protocol_no | C | Max126Text | 只有成功时该字段才有值,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 银行卡识别码 | sgn_acc | C | Max32Text | 银行卡号后四位只有成功时该字段才有值 |
12 | 账户信息 | acc_info | C | Max11Numeric | 只有成功时该字段才有值,卡号和手机号脱敏,格式:身份证号|持卡人姓名|卡号|手机号,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
13 | 银行编码 | bank_code | C | Max10Text | 只有在绑卡成功后该字段才有值 |
14 | 银行名称 | bank_name | C | Max10Text | 只有在绑卡成功后该字段才有值 |
15 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES 加密方式:Base64转码后使用宝付的公钥加密 |
16 | 商户保留域1 | req_reserved1 | O | Max255Text | |
17 | 商户保留域2 | req_reserved2 | O | Max255Text | |
18 | 系统保留域1 | additional_info1 | O | Max255Text | |
19 | 系统保留域2 | additional_info2 | O | Max255Text | |
20 | 签名域 | signature | M | Max512Text | |
21 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
22 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
-说明
1)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时必返回,在“签名方式”为国际算法时如请求时上送则返回。
2.2.6异步结果通知
异步通知以GET和POST方式发送到商户配置的接收地址,商户接收到签约结果,并且进行相应处理之后,需要商户接收通知的地址在页面上输出 OK 表示接收成功<除了 OK 无任何其他内容>,告诉宝付已经成功接收并处理完毕,宝付系统在未得到商户接收通知成功的反馈时,将通过重发机制再次通知商户(重发次数 2~10 次,请以第一次收到的签约成功的消息为准),直到商户接收成功或达到最大重发次数为止。
异步结果通知
序号 | 域名 | 变量名 | 必填标识 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 报文发送日期时间 | send_time | M | ISODateTime | 发送方发出本报文时的机器日期时间,如 2017-12-19 20:19:19 |
2 | 应答报文流水号 | msg_id | M | Max32Text | 商户预签约流水号 |
3 | 报文编号/版本号 | version | M | Max7Text | 4.0.0.0 |
4 | 应答码 | resp_code | M | Max16Text | 具体参见附录:商户接口应答码 |
5 | 终端号 | terminal_id | M | Max11Numeric | |
6 | 交易类型 | txn_type | M | code | |
7 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业返回码 | biz_resp_code | M | 具体参见附录1:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 签约协议号 | protocol_no | C | Max126Text | 只有成功时该字段才有值,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 银行卡识别码 | sgn_acc | C | Max32Text | 银行卡号后四位只有成功时该字段才有值 |
12 | 账户信息 | acc_info | C | Max11Numeric | 只有成功时该字段才有值,卡号和手机号脱敏,格式:身份证号|持卡人姓名|卡号|手机号,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
13 | 银行编码 | bank_code | C | Max10Text | 只有在绑卡成功后该字段才有值 |
14 | 银行名称 | bank_name | C | Max10Text | 只有在绑卡成功后该字段才有值 |
15 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES 加密方式:Base64转码后使用宝付的公钥加密 |
16 | 商户保留域1 | req_reserved1 | O | Max255Text | |
17 | 商户保留域2 | req_reserved2 | O | Max255Text | |
18 | 系统保留域1 | additional_info1 | O | Max255Text | |
19 | 系统保留域2 | additional_info2 | O | Max255Text | |
20 | 签名域 | signature | M | Max512Text | |
21 | 加密证书序列号 | ncrptn_sn | O | Max20Text | 接收方公钥证书序列号 |
22 | 签名证书序列号 | sign_sn | O | Max512Text | 发送方公钥证书序列号 |
- 说明:
1)“账户信息”
“账户信息”默认脱敏,如果卡号信息,则联系宝付业务人员配置后返回。
2)“加密证书序列号”“签名证书序列号”
“加密证书序列号”和“签名证书序列号”在“签名方式”为国密方式(取值为10)时必返回,在“签名方式”为国际算法时如请求时上送则返回。
3 应答码
3.1商户接口应答码
应答码 | 含义 |
---|---|
S | 成功 |
F | 失败 |
I | 处理中 |
FF | 失败(支付结果查询类交易才会返回,表示订单查询参数错误或其他原因导致的订单查询失败,而非订单交易失败) |
3.2 宝付业务应答码
更多应答码,详见业务应答码附件
4 数据元类型说明
A1交易类型
交易类型 | 交易描述 |
---|---|
79 | 协议支付一键绑卡预申请(后台模式) |
80 | 协议支付一键绑卡预申请(后台模式) |
81 | 协议支付一键绑卡预申请(前台模式)推荐 |
82 | 协议支付一键绑卡签约(前台模式)推荐 |
03 | 协议支付查询历史绑定的银行卡 |
78 | 协议支付一键绑卡签约流水结果查询 |
04 | 协议支付解约请求 |
A2卡类型- card_type
类型编码 | 含义 |
---|---|
100 | 不限制 |
101 | 借记卡 |
102 | 信用卡 |
A3证件类型- id_card_type
类型编码 | 含义 |
---|---|
01 | 身份证 |
12 | 港澳居民居住证 |
13 | 台湾居民居住证 |
A4银行编码
银行代码 | 银行名称 |
---|---|
ICBC | 中国工商银行 |
ABC | 中国农业银行 |
CCB | 中国建设银行 |
BOC | 中国银行 |
BCOM | 中国交通银行 |
CIB | 兴业银行 |
CITIC | 中信银行 |
CEB | 中国光大银行 |
PAB | 平安银行 |
PSBC | 中国邮政储蓄银行 |
SHB | 上海银行 |
SPDB | 浦东发展银行 |
CMBC | 中国民生银行 |
CMB | 招商银行 |
GDB | 广发银行 |
ZSB | 浙商银行 |
BOB | 北京银行 |
- 更多银行编码缩写下载
5 风控参数字段说明
通用参数
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | goodsCategory | 行业类目 | String | O | 参见数据字典“行业类目” |
2 | userLoginId | 商户用户登录名 | String | O | 用户在商户系统中的登陆名(手机号、邮箱等标识) |
3 | userEmail | 用户邮箱 | String | O | 用户在商户系统中注册的邮箱 |
4 | userMobile | 绑定手机号 | String | O | 商户系统中绑定手机号,如有,需要传送 |
5 | registerUserName | 用户注册姓名 | String | O | |
6 | identifyState | 是否实名认证 | String | O | 1是 0不是 |
7 | userIdNo | 用户身份证号 | String | O | |
8 | registerTime | 注册时间 | String | O | YYYYMMDDHHMMSS |
9 | registerIp | 注册IP | String | O | 用户在商户端注册时留存的IP |
10 | chName | 持卡人姓名 | String | O | |
11 | chIdNo | 持卡人身份证号 | String | O | |
12 | chCardNo | 持卡人银行卡号 | String | O | |
13 | chMobile | 持卡人手机 | String | O | |
14 | chPayIp | 持卡人支付IP | String | M | 持卡人在支付时的IP地址;如支付场景中,无法获取有效的持卡人IP,请直接传参127.0.0.1即可 |
15 | deviceOrderNo | 设备指纹订单号 | String | O | 生成设备指纹的订单号(用于快捷),如果和支付订单号一致,传相同的值 |
16 | risk_info | 风险信息域 | String | C | 特定渠道下签约必填,详情咨询对接技术人员 |
风险信息域risk_info
序号 | 字段 | 字段名称 | 字段类型 | 必填项 | 备注 |
---|---|---|---|---|---|
1 | merUserRegDt | 用户注册时间 | String[14] | M | |
2 | usrLoginMethod | 用户本次登录验证方式 | String[5] | M | 位图形式,可扩展:11111; 登录密码 |
3 | usrLoginTime | 用户本次登录时间 | String[17] | M | 格式:yyyyMMddHHmmss |
4 | usrLoginMessageTime | 用户在当前设备最近一次登录注册手机号 短信验证通过时间 | String[17] | M | 格式:yyyyMMddHHmmss |
5 | usrLoginFaceTime | 用户在当前设备最近一次人脸验证通过时间 | String[17] | M | 格式:yyyyMMddHHmmss |
6 | usrLoginPasswordTime | 用户在当前设备最近一次支付密码验证通过时间 | String[17] | M | 格式:yyyyMMddHHmmss |
7 | deviceID | 设备标识 | String(1..64) | M | 移动终端设备的唯一标识 |
8 | usrActivity | 用户活跃度 | String(1..3) | M | 用户最近一次打开应用服务 APP距今天数;数值范围:0-999。大于999天赋值999 |
9 | usrFrequentAreaCode | 用户常用地 | String[4] | M | 6个月内打开应用服务方APP 时 GPS定位最多的城市,根据《银联卡跨行业务地区代码 标准》赋值 4 位数字 |
10 | countryCode | 国家代码 | String[1..4] | M | 用户所在国家 |
11 | districtCode | 地区代码 | String[1..6] | M | 用户所在地区 |
国家代码
编码 | 名称 |
---|---|
CN | 中国(CHINA) |
- 更多国家代码下载
机场代码
参照国际航空运输协会规定的3位机场代码,国际通用代码,因此每家商户都一致。
省份,区域代码
参照我司省份、区域代码表
- 省市区编码下载
最后编辑:xiaofeng 更新时间:2025-01-09 17:41