- 版本说明
- 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 返回报文
- 2. 业务接口说明
- 2.1 业务接口
- 2.1.1 预绑卡
- 请求报文
- 返回报文
- 2.1.2 确认绑卡
- 交易URL
- 请求报文
- 返回报文
- 2.1.3 直接支付类交易
- 交易URL
- 请求报文
- 返回报文
- 2.1.4 预支付类交易(可选)
- 交易URL
- 请求报文
- 返回报文
- 2.1.5 确认支付类交易(可选)
- 交易URL
- 请求报文
- 返回报文
- 2.1.6 解除银行卡绑定
- 交易URL
- 请求报文
- 返回报文
- 2.1.7 绑定结果查询
- 交易URL
- 请求报文
- 返回报文
- 2.1.8 支付结果查询类交易
- 交易URL
- 请求报文
- 返回报文
- 2.1.9 交易结果异步通知
- 返回报文
- 2.1.10 解约结果异步通知
- 返回报文
- 2.1.11 分账订单查询类交易
- 请求报文
- 返回报文
- 2.1.12 分账结果异步通知
- 返回报文
- 2.1.13 批量新代收
- 交易URL
- 请求报文
- 加密数据
- 应答报文(宝付返回报文)
- 2.1.14 批量新代收单笔查询
- 请求报文
- 加密数据
- 应答报文(宝付返回报文)
- 2.1.15 批量新代收异步通知
- 功能说明
- 通知报文
- 解密后报文
- 加密数据
- 2.1.16 批量新代收批次查询
- 交易URL
- 请求报文
- 加密数据
- 应答报文(宝付返回报文)
- 3. 附录1 新代收保留域
- 3.1 新代收保留域字段说明
- 3.2 新代收保留域数据字典
- 3.2.1 新代收业务类种类编码
- 3.2.2 新代收收款周期
- 4. 附录2 风控参数字段说明
- 4.1 风控参数字段说明
- 通用参数
- 电商
- 互金消金
- 航旅
- 酒店
- 保险
- 游戏
- 大宗
- 4.2 风控参数数据字典
- 商品类目(prodTypeList)
- 行业类目(goodsCategory)
- 证件类型
- 交易类型(btType)
- 帐户类型(btAcctType)
- 国家代码
- 机场代码
- 省份,区域代码
- 5. 附录3(规范性附录)数据元类型
- 5.1 交易类型枚举
- 5.2 卡类型枚举-card_type
- 5.3 证件类型枚举-id_card_type
- 5.4 银行编码
- 6. 附录4(规范性附录)返回码信息
- 6.1 商户接口应答码
- 6.2 业务应答码
版本说明
版本发布日期 2023年2月9日
版本号:4.0.0.2
增加宝付页面跳转
版本发布日期 2022年9月18日
版本号:4.0.0.0
接口创建
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解码
2. 业务接口说明
2.1 业务接口
2.1.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 | 卡类型 | card_type | M | code | 见附录:枚举类型 |
10 | 证件类型 | id_card_type | M | code | 见附录:枚举类型 |
11 | 账户信息 | acc_info | M | Max200Text | 格式:银行卡号|持卡人姓名|证件号|手机号|银行卡安全码|银行卡有效(yymm),加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
12 | 商户保留域1 | req_reserved1 | O | Max255Text | |
13 | 商户保留域2 | req_reserved2 | O | Max255Text | |
14 | 系统保留域1 | additional_info1 | O | Max255Text | |
15 | 系统保留域2 | additional_info2 | O | Max255Text | |
16 | 新代收专属保留域 | entrust_req_reserved | M | Max255Text | Json字符串,详见附录1:新代收保留域字段说明 |
17 | 风控参数保留域 | risk_item | M | Max255Text | Json字符串,详见附录2:风控参数说明 |
18 | 签名域 | signature | M | Max255Text |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | Max11Numeric | 具体参见附录:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | code | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | Max50Text | 具体参见附录:业务应答码 |
9 | 业务返回说明 | biz_resp_msg | M | Max50Text | |
10 | 预签约唯一码 | unique_code | C | Max126Text | 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用商户的公钥加密 |
12 | 商户保留域1 | req_reserved1 | O | Max255Text | |
13 | 商户保留域2 | req_reserved2 | O | Max255Text | |
14 | 系统保留域1 | additional_info1 | O | Max255Text | [sign_sms]false[/sign_sms];sign_sms节点中间是false代表原来宝付发送的绑卡短信不再发送 |
15 | 系统保留域2 | additional_info2 | O | Max255Text | |
16 | 签名域 | signature | M | Max512Text |
2.1.2 确认绑卡
绑定银行卡是指经过持卡人授权将个人银行卡和商户建立绑定关系,支付时不再需要输入银行卡信息。商户需先进行预绑卡,宝付(或银行)会发送短信验证码(可根据银行要求来配置是否发送)给持卡人,商户再使用确认绑卡接口,将短信验证码回传给宝付完成绑卡。
交易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 | 预签约唯一码 | unique_code | M | Max126Text | 格式:预签约唯一码|短信验证码;加密方式: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 | Max255Text |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | Max11Numeric | 具体参见附录:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | code | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | Max50Text | 具体参见附录:业务应答码 |
9 | 业务返回说明 | biz_resp_msg | M | Max50Text | |
10 | 签约协议号 | protocol_no | C | Max126Text | 只有成功时该字段才有值;加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 银行编码 | bank_code | C | Max10Text | 只有在绑卡成功后该字段才有值 |
12 | 银行名称 | bank_name | C | Max10Text | 只有在绑卡成功后该字段才有值 |
13 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用商户的公钥加密 |
14 | 商户保留域1 | req_reserved1 | O | Max255Text | |
15 | 商户保留域2 | req_reserved2 | O | Max255Text | |
16 | 系统保留域1 | additional_info1 | O | Max255Text | |
17 | 系统保留域2 | additional_info2 | O | Max255Text | |
18 | 签名域 | signature | M | Max512Text |
2.1.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 | 见附录:交易类型枚举 |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 商户订单号 | trans_id | M | Max50Text | 唯一订单号,8-50 位字母和数字,未支付成功的订单号可重复提交,重复提交时交易参数不得发生变化 |
8 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用宝付的公钥加密 |
9 | 用户ID | user_id | O | Max50Text | 用户在商户平台唯一ID |
10 | 签约协议号 | protocol_no | M | Max126Text | 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 订单金额 | order_amt | C | Max12Numeric | 交易类型为116、118时必填;单位:分;例:1元则提交100;订单金额=交易金额+营销金额 |
12 | 交易金额 | txn_amt | M | Max12Numeric | 单位:分;例:1元则提交100 |
13 | 卡信息 | card_info | C | Max126Text | 当使用信用卡支付时,需上传。格式:信用卡有效期(yymm)|安全码;加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
14 | 风控参数 | risk_item | M | 不限制 | Json格式,详细参数见风控参数字段说明(通用参数、电商、互金消金、航旅、酒店、宝信、游戏、大宗) |
15 | 交易成功通知地址 | return_url | O | Max500Text | 最多填写三个地址;不同的地址用‘|’连接 |
16 | 分账手续费商户 | fee_member_id | O | Max11Numeric | 指定分账手续费商户 |
17 | 分账信息 | share_info | O | 不限制 | 交易类型为114、118时必填;单位(分);格式:商户1,金额1;商户2,金额2…例如:100000363,10;100000364,90; |
18 | 分账结果通知地址 | share_notify_url | O | 不限制 | 分账成功之后通知地址 |
19 | 营销账户信息 | union_info | O | 变(200) | 金额单位(分);格式:商户1,金额1;商户2,金额2…例如:100000363,5;100000364,5; |
20 | 商户保留域1 | req_reserved1 | O | Max255Text | |
21 | 商户保留域2 | req_reserved2 | O | Max255Text | |
22 | 系统保留域1 | additional_info1 | O | Max255Text | |
23 | 系统保留域2 | additional_info2 | O | Max255Text | |
24 | 系统保留域3 | additional_info3 | M | Max255Text | 格式: [business_type]业务类型[/usiness_type]业务类型详见新代收业务类种类编码;[commodit]商品简称商品数量[/commodit]内容由商品简称(或服务)加数量组成,示例:[commodit]手机1耳机2 [/commodit] |
25 | 签名域 | signature | M | Max512Text |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录1:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 成功金额 | succ_amt | C | Max12Numeric | 单位:分。例:1元则100 |
11 | 成功时间 | succ_time | C | ISODateTime | 支付成功时间 |
12 | 宝付订单号 | order_id | C | Max32Numeric | |
13 | 商户订单号 | trans_id | R | Max50Text | |
14 | 商户保留域1 | req_reserved1 | O | Max255Text | |
15 | 商户保留域2 | req_reserved2 | O | Max255Text | |
16 | 系统保留域1 | additional_info1 | O | Max255Text | |
17 | 系统保留域2 | additional_info2 | O | Max255Text | |
18 | 签名域 | signature | M | Max512Text |
2.1.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 | 见附录:交易类型枚举 |
6 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
7 | 商户订单号 | trans_id | M | Max50Text | 唯一订单号,8-50 位字母和数字,未支付成功的订单号可重复提交,重复提交时交易参数不得发生变化 |
8 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用宝付的公钥加密 |
9 | 用户ID | user_id | O | Max50Text | 用户在商户平台唯一ID |
10 | 签约协议号 | protocol_no | M | Max126Text | 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
11 | 交易金额 | txn_amt | M | Max12Numeric | 单位:分;例:1元则提交100 |
12 | 风控参数 | risk_item | M | 不限制 | Json格式,详细参数见风控参数字段说明(通用参数、电商、互金消金、航旅、酒店、宝信、游戏、大宗) |
13 | 交易成功通知地址 | return_url | O | Max500Text | 最多填写三个地址;不同的地址用‘|’连接 |
14 | 分账手续费商户 | fee_member_id | O | Max11Numeric | 指定分账手续费商户 |
15 | 分账信息 | share_info | O | 不限制 | 交易类型为114、118时必填;单位(分);格式:商户1,金额1;商户2,金额2…例如:100000363,10;100000364,90; |
16 | 分账结果通知地址 | share_notify_url | O | 不限制 | 分账成功之后通知地址 |
17 | 商户保留域1 | req_reserved1 | O | Max255Text | |
18 | 商户保留域2 | req_reserved2 | O | Max255Text | |
19 | 系统保留域1 | additional_info1 | O | Max255Text | |
20 | 系统保留域2 | additional_info2 | O | Max255Text | |
21 | 系统保留域3 | additional_info3 | M | Max255Text | 格式: [business_type]业务类型[/usiness_type]业务类型详见新代收业务类种类编码;[commodit]商品简称商品数量[/commodit]内容由商品简称(或服务)加数量组成,示例:[commodit]手机1耳机2 [/commodit] |
22 | 签名域 | signature | M | Max512Text |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录1:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用宝付的公钥加密 |
11 | 预支付唯一码 | unique_code | C | Max126Text | 预支付成功后返回;加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
12 | 商户保留域1 | req_reserved1 | O | Max255Text | |
13 | 商户保留域2 | req_reserved2 | O | Max255Text | |
14 | 系统保留域1 | additional_info1 | O | Max255Text | |
15 | 系统保留域2 | additional_info2 | O | Max255Text | |
16 | 签名域 | signature | M | Max512Text |
2.1.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 | 报文流水号 | 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 | 预支付唯一码 | unique_code | M | Max255Text | 格式:预支付唯一码|短信验证码,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
9 | 卡信息 | card_info | C | Max126Text | 当使用信用卡支付时,需上传。格式:信用卡有效期(yymm)|安全码,加密方式: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 |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 宝付订单号 | order_id | C | Max32Numeric | |
9 | 商户订单号 | trans_id | R | Max50Text | |
10 | 业务返回码 | biz_resp_code | M | 具体参见附录1:业务应答码 | |
11 | 业务返回说明 | biz_resp_msg | M | ||
12 | 成功金额 | succ_amt | C | Max12Numeric | 单位:分,例:1元则提交100 |
13 | 成功时间 | succ_time | C | ISODateTime | 支付成功时间 |
14 | 商户保留域1 | req_reserved1 | O | Max255Text | |
15 | 商户保留域2 | req_reserved2 | O | Max255Text | |
16 | 系统保留域1 | additional_info1 | O | Max255Text | |
17 | 系统保留域2 | additional_info2 | O | Max255Text | |
18 | 签名域 | signature | M | Max512Text |
2.1.6 解除银行卡绑定
解绑是指持卡人发起的银行卡和商户解除绑定关系的业务。
交易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. | 签约协议号 | protocol_no | M | Max126Text | 加密方式: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 |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | Max16Text | 具体参见附录:商户接口应答码 |
5 | 终端号 | terminal_id | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | code | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
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 |
2.1.7 绑定结果查询
交易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 | C | 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 |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
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 | 签名域 | signature | M | Max512Text | |
16 | 协议列表 | protocols | M | Max1024Text | 格式:签约协议号|用户ID|银行卡号|银行编码|银行名称; 签约协议号|用户ID|银行卡号|银行编码|银行名称,加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
17 | 新代收专属保留域 | entrust_req_reserved | M | Max255Text | Json字符串,详见附录:新代收保留域字段说明 |
18 | 签名域 | signature | M | Max512Text |
2.1.8 支付结果查询类交易
当系统返回异常或其他原因导致订单状态不明确时,可通过该接口查询订单状态。
交易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 | 商户原始订单号 | orig_trans_id | M | Max50Text | 商户提交的标识支付的唯一原订单号 |
8 | 交易日期 | orig_trade_date | M | ISODateTime | 格式:yyyy-MM-dd HH:mm:ss如2017-12-19 20:19:19 |
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 |
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录1:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 成功金额 | succ_amt | C | Max12Numeric | 单位:分,例:1元则100 |
11 | 成功金额 | order_amt | C | Max12Numeric | 组合支付返回;单位:分;例:1元则100;返回订单金额(营销账户金额+交易金额) |
12 | 交易金额 | trade_amt | C | Max12Numeric | 单位:分,例:1元则100 |
13 | 营销金额 | market_amt | C | Max12Numeric | 单位:分,例:1元则100 |
14 | 成功时间 | succ_time | C | ISODateTime | 支付成功时间 |
15 | 宝付订单号 | order_id | C | Max32Numeric | |
16 | 商户订单号 | trans_id | R | Max50Text | |
17 | 商户保留域1 | req_reserved1 | O | Max255Text | |
18 | 商户保留域2 | req_reserved2 | O | Max255Text | |
19 | 系统保留域1 | additional_info1 | O | Max255Text | |
20 | 系统保留域2 | additional_info2 | O | Max255Text | |
21 | 签名域 | signature | M | Max512Text |
2.1.9 交易结果异步通知
如果直接支付类交易或预绑卡支付时上传了异步通知地址(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
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 应答码 | resp_code | M | Max16Text | 具体参见附录5:商户接口应答码 |
2 | 终端号 | terminal_id | R | Max11Numeric | |
3 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
4 | 业务返回码 | biz_resp_code | M | Max16Text | 具体参见附录:业务应答码 |
5 | 业务返回说明 | biz_resp_msg | M | ||
6 | 宝付订单号 | order_id | M | Max32Numeric | |
7 | 商户原始订单号 | trans_id | M | Max50Text | 商户支付时上传的订单号 |
8 | 成功金额 | succ_amt | C | Max12Numeric | 单位:分。例:1元则100,订单成功时返回 |
9 | 成功时间 | succ_time | C | ISODateTime | 支付成功时间,订单成功时返回 |
10 | 签名域 | signature | M | Max512Text |
2.1.10 解约结果异步通知
配置了解约通知的商户,在收到银行解约通知后,宝付完成商户解约后通知到商户,使用配置的终端进行签名
例如:bind_id=1202009101455011600000132630&mask_card_holder=三&mask_id_card_no=101001**1234&mask_bank_card_no=6228281234&mask_mobile=131*1234&signature=8ab74c7869632dc395cc945adcc388e6afceb759e4d406c3bb6e0e8002ec422f1615f2a43966d7337dcc57963f18877a959fe9f67b082da2cd95217ba003cc81f07962d665f576509ebc1a38f7ddf2a423775a794b262b7ffc4af615da3ba6bd05d0672c004d7cf80be3ed236f268078bb5c700d4b0a6ae9a0e58f2c782bd6ef
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
6 | 协议号 | bind_id | M | Max32Text | 签约协议号 |
7 | 姓名掩码 | mask_card_holder | M | Max50Text | 掩去第一位 |
8 | 证件号掩码 | mask_id_card_no | M | Max32Numeric | 保留前6后4 |
9 | 卡号掩码 | mask_bank_card_no | M | Max19Text | 保留前6后4 |
10 | 手机号掩码 | mask_mobile | M | Max11Text | 保留前3后4 |
11 | 签名域 | signature | M | Max512Text |
2.1.11 分账订单查询类交易
当系统返回异常或其他原因导致订单状态不明确时,可通过该接口查询订单状态。
交易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 | 商户原始订单号 | orig_trans_id | M | Max50Text | 商户提交的标识支付的唯一原订单号 |
8 | 交易日期 | orig_trade_date | M | ISODateTime | 格式:yyyy-MM-dd HH:mm:ss如2017-12-19 20:19:19 |
9 | 分账流水号 | share_msg_id | C | Max32Text | 分账时商户上送的流水号 |
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 |
- 注:该接口响应参数resp_code只会返回S(成功)和F(失败)。F代表接口参数错误或者分账订单不存在。S代表分账订单存在,具体的订单状态和分账状态需要判断order_state和share_state的返回值。
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
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 | R | Max11Numeric | |
6 | 交易类型 | txn_type | R | Max11Text | |
7 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
8 | 业务返回码 | biz_resp_code | M | 具体参见附录:业务应答码 | |
9 | 业务返回说明 | biz_resp_msg | M | ||
10 | 订单状态 | order_state | C | Max2Numeric | 1:交易成功;2:交易处理中;0:未支付;-1:交易失败 |
11 | 分账状态 | share_state | C | Max2Numeric | 订单状态为“1”时才会分账;1:分账成功;0:待分账 |
12 | 商户保留域1 | req_reserved1 | O | Max255Text | |
13 | 商户保留域2 | req_reserved2 | O | Max255Text | |
14 | 系统保留域1 | additional_info1 | O | Max255Text | |
15 | 系统保留域2 | additional_info2 | O | Max255Text | |
16 | 签名域 | signature | M | Max512Text |
2.1.12 分账结果异步通知
例如:biz_resp_code= BF00338&biz_resp_msg=分账成功& member_id=100000749 &resp_code=S&trans_id=201803221785&signature=8ab74c7869632dc395cc945adcc388e6afceb759e4d406c3bb6e0e8002ec422f1615f2a43966d7337dcc57963f18877a959fe9f67b082da2cd95217ba003cc81f07962d665f576509ebc1a38f7ddf2a423775a794b262b7ffc4af615da3ba6bd05d0672c004d7cf80be3ed236f268078bb5c700d4b0a6ae9a0e58f2c782bd6ef&terminal_id=100000949& order_id =58752185
如果直接支付类分账交易上传了分账异步通知地址(share_notify_url字段),当分账成功后会收到宝付的异步通知。
返回报文
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 应答码 | resp_code | M | Max16Text | 具体参见附录:商户接口应答码 |
2 | 终端号 | terminal_id | R | Max11Numeric | |
3 | 商户号 | member_id | R | Max11Numeric | 宝付提供给商户的唯一编号 |
4 | 业务返回码 | biz_resp_code | M | 具体参见附录:业务应答码 | |
5 | 业务返回说明 | biz_resp_msg | M | ||
6 | 宝付订单号 | order_id | M | Max32Numeric | |
7 | 商户原始订单号 | trans_id | M | Max50Text | 商户支付时上传的订单号 |
8 | 分账流水号 | msg_id | C | Max32Text | 分账时商户上传的流水号 |
9 | 签名域 | signature | M | Max512Text |
2.1.13 批量新代收
商户分批次通过接口传递扣款请求,宝付实时回复收到请求响应;后端发各银行扣款后,再异步通知商户每一条订单的结果(成功或失败);同时,商户可以来查询每笔订单或某批次的订单。
注:该接口为纯后台模式
流程说明:
1、商户将批量协议支付订单发送至宝付,单笔明细采用分隔符#连接交易要素,最大支持200笔明细;
2、宝付做商户接入校验,IP、模板等后,同步返回受理成功响应给商户;
3、宝付异步并发处理交易明细,支付要素验证成功后,向银行发扣款请求;
4、银行/银联将交易处理完成并通知宝付交易结果;
5、宝付将交易结果(成功或失败)异步发送给商户。
新代收批量支付交易是指商户通过批量接口传递多笔新代收支付明细,宝付实时回复收到请求响应受理;后端发各银行进行扣款,银行反馈宝付扣款结果后,宝付再异步通知商户每一条订单的结果(成功或失败),该模式属于后台支付模式。
交易URL
测试环境地址:https://vgw.baofoo.com/batchpay/api/batchTransRequest
正式环境地址:https://public.baofoo.com/batchpay/api/batchTransRequest
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 版本号 | version | M | 4.0.0.2(请使用此固定版本号) |
2 | 终端号 | terminal_id | M | |
3 | 商户号 | member_id | M | 宝付提供给商户的唯一编号 |
4 | 交易类型 | txn_type | M | 取值:0631 |
5 | 交易子类 | txn_sub_type | M | 取值:99 |
6 | 加密数据类型 | data_type | M | data_type=xml或json (推荐使用json) |
7 | 加密数据 | data_content | M | 具体参数如下加密数据.注意:加密之前,先将组装的数据(请参照数据模版组装)进行Base64编码转化,然后再进行证书加密。 |
加密数据
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 终端号 | terminal_id | M | |
2 | 商户号 | member_id | M | 宝付提供给商户的唯一编号 |
3 | 交易子类 | txn_sub_type | M | 取值:99 |
4 | 商户流水号 | trans_serial_no | M | 8-50 位字母和数字,每次请求都不可重复 |
5 | 商户批次号 | trans_batch_id | 商户请求批次号,每次请求都不可重复 | |
6 | 新代收数据域 | actual_info | M | 实际信息 最多支持5000条 |
- 实际信息说明:actual_info为实际信息集合,子节点为info,最多支持200个子节点,info内具体内容采用分隔符”#”分割模式,请注意分割字段内容中不要在出现分隔符导致混淆。
- 字段分割顺序如下:
trans_id#trans_date#txn_amt#protocol_no#req_reserved
- 各字段具体介绍如下
序号 | 节点 | info | 必填 | 最大支持5000条明细 |
---|---|---|---|---|
1 | 商户订单号 | trans_id | M | 唯一订单号,8-50 位字母和数字,注:支付请求中trans_id作为主键,请保证唯一性,对于同一批次内出现重复的订单均置为失败。如果有不同批次内重复的交易请求存在,以第一个成功交易为准,后续重复交易不被受理。不支持商户提交重复订单号,对重复订单号将直接提示订单已经提交。 |
2 | 订单日期 | trans_date | M | 14 位定长。格式:年年年年月月日日时时分分秒秒 |
3 | 交易金额 | txn_amt | M | 单位:分;例:1元则提交100 |
4 | 签约协议号 | protocol_no | O | 签约协议号 |
5 | 请求方保留域 | req_reserved | O | 长度不超过 128 位 |
加密数据模板:
- XML
<?xml version="1.0" encoding="UTF-8" ?> <data_content> <terminal_id>10001</terminal_id> <member_id>100000362</member_id> <txn_sub_type >32</ txn_sub_type > <trans_serial_no>32132132130001</trans_serial_no> < trans_batch_id>32132132130001</ trans_batch_id> <actual_info > <info>20240905141650749#20240905121111#20000#1201812081431102920000005894#保留域</ info > <info>20240905141650100#20240905121111#20100#1201812081431102920000005895#保留域</ info > <info>202409051416507101#20240905121111#52000#1201812081431102920000005884#保留域</ info > <actual_info > </data_content>
- JSON
" data_content": { "terminal_id":"10001", "member_id":"100000362", "trans_serial_no":"32132132130001", "trans_batch_id ":"32132132130001", "actual_info":{ "info":[ "20240905141650749#20240905121111#20000#1201812081431102920000005894#保留域", "20240905141650100#20240905121111#20100#1201812081431102920000005895#保留域" ] } }
应答报文(宝付返回报文)
支付响应结果由宝付通过非对称加密公私钥方式发送给商户。商户接收到宝付的响应报文,将接收到的内容,用宝付发给商户且后缀为(*.cer)的公钥证书进行解密。
请求响应结果的数据类型根据请求参数字段“data_type”来决定,输出内容包括
序号|域名| 变量名|必填|备注
-|-|-|-|-
1|应答码|resp_code|M|具体参见附录:应答码
2|应答信息| resp_msg| M| 填写具体的应答信息
3|商户号| member_id|M| 宝付提供给商户的唯一编号
4|终端号| terminal_id| M |
5|批次号| batch_id| C |
2.1.14 批量新代收单笔查询
商户可通过该接口向我司发起查询请求,查询单笔订单的状态,宝付根据商户请求的原交易订单号返回该笔订单支付是否成功。如有重复发起交易的订单,以第一个成功交易为准,返回该订单相关信息。
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 版本号 | version | M | 4.0.0.2(请使用此固定版本号) |
2 | 终端号 | terminal_id | M | |
3 | 交易类型 | txn_type | M | 取值:0631 |
4 | 交易子类 | txn_sub_type | M | 取值:20 |
5 | 商户号 | member_id | M | |
6 | 加密数据类型 | data_type | M | data_type =xml或json |
7 | 加密数据 | data_content | M | 具体参数如下加密数据 |
加密数据
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 交易子类 | txn_sub_type | M | 取值:20 |
2 | 终端号 | terminal_id | M | |
3 | 商户号 | member_id | M | 宝付提供给商户的唯一编号 |
4 | 商户流水号 | trans_serial_no | M | 8-50 位字母和数字,每次请求都不可重复 |
5 | 商户订单号 | trans_id | M |
加密数据模板:
XML
<?xml version="1.0" encoding="utf-8"?>
<data_content>
<txn_sub_type>20</txn_sub_type>
<terminal_id>100000933</terminal_id>
<member_id>100000749</member_id>
<trans_id>20160724143920108</trans_id>
<trans_serial_no>20160727130342</trans_serial_no>
</data_content>
JSON
{
"txn_sub_type": "20",
"terminal_id": "100000933",
"member_id": "100000749",
"trans_serial_no": "20160727125614",
"trans_id": "20160724143920108"
}
应答报文(宝付返回报文)
支付响应结果由宝付通过非对称加密公私钥方式发送给商户。商户接收到宝付的响应报文,将接收到的内容,用宝付发给商户且后缀为(*.cer)的公钥证书进行解密。
应答结果解密后的报文格式是根据原交易订单请求的“data_type”来决定,输出内容包括
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 应答码 | resp_code | M | 具体参见附录:应答码 |
2 | 应答信息 | resp_msg | M | 填写具体的应答信息 |
3 | 商户号 | member_id | R | 宝付提供给商户的唯一编号 |
4 | 终端号 | terminal_id | R | |
5 | 数据域 | order_info | R | 实际信息 ;如有重复订单,以第一个成功交易为准返回 |
- 实际信息说明:order_info为实际信息集合,具体结果参数如下:
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 商户订单日期 | trans_date | ||
2 | 商户订单号 | trans_id | M | 填写具体的应答信息 |
3 | 批次号 | batch_id | M | 宝付提供给商户的宝付批次编号 |
4 | 订单状态 | order_stat | M | I-处理中 S-成功 F-失败 |
5 | 数据域 | resp_code | M | |
6 | 交易码 resp_msg | M | ||
7 | 交易描述 | trans_no | C | |
8 | 成功金额 | succ_amt | C | 成功金额 |
9 | 商户保留域 | req_reserved | O | |
10 | 商户批次号 | trans_batch_id | M | 商户请求时提供的批次编号 |
XML
<?xml version="1.0" encoding="utf-8"?>
<result>
< resp_code >0000</ resp_code >
< resp_msg >查询成功</ resp_msg >
<member_id>100000749</member_id>
<terminal_id>100000933</terminal_id>
<order_info>
<trans_date>20160724143907</trans_date>
<trans_id>20160724143920108</trans_id>
<batch_id>2016072640195</ batch_id >
<order_stat>S</order_stat>
<resp_code>0000</resp_code>
<resp_msg>交易成功</resp_msg>
<trans_no>201607260110000600022073</trans_no>
<succ_amt>1.00</succ_amt>
<req_reserved>保留域</req_reserved>
<trans_batch_id>123321323232</trans_batch_id>
</order_info>
</result>
JSON
{
" resp_code ": "0000",
" resp_msg": "查询成功",
"member_id": "100000749",
"terminal_id": "100000933",
" order_info ": {
"batch_id": "2016072640195",
"order_stat": "S",
"req_reserved": "",
"resp_code": "0000",
"resp_msg": "交易成功",
"succ_amt": "1.00",
"trans_date": "20160724143907",
"trans_id": "20160724143920108",
"trans_no": "201607260110000600022073",
"trans_batch_id ": "4343433433222"
}
}
2.1.15 批量新代收异步通知
功能说明
该接口商户接收通知的异步地址请联系对接讨论组宝付技术支持或商户经理协助进行配置,配置后方可使用。
通知报文
data_content=261a490a45070b3dd58ca5efa058b35973f39ebbdff5356d942a36cfe364726d7092a4305b22e758c3d95d66967bff9de548353adc265b906cebc0e942bf3f077e9f92344197d5a710ac925f43f8aa0c89df16b4fcef412ee5f56a36d8dfbdda39389146d0a6ae760acf94618e14b4f0bf37b77fbb3481c7739a7b421f3037ff90d5b1dadab1ed480683f02b9c5ad718f7602de55b8db0733c7632113c7b3635aeb1f06ab852567508f1b8ade380b071eeefdba4584c785aeb6f9f8b5c488b4ef8dbec978ef33d4ead8f4950d5d10186484842c73d064c49097b0d3e2dc13b891cace19c4766c7e73f0f6241090ec14cb273d1e655d895da21aafc159058765367dfa7983ba1c60a9f752032e25fab9324562c6bfdf5c4ab921f6b99b07b36205c819564260bd5e096d6a613114f4a64331c795e27b4d4d5f138e4602ed2a45cac28a57dd93723de0324360574ba0f0b0732c3e5f423eb05b1e3518dcbef9018b5440e497f9981b0c12dceb27e7c951cdc3a3236f26c2fffc60f739013f674c096aa6ba969ad2291d1f1ca41e15054193c8c8c15d4702afdda3acf0b8aab30274d2f96b24db5addb57c0709146cb3058aa1f35b54bc544376f4b1d4791e71a5bbc7d2e37e4ae7b56ce77926c4c3cb6b36515e2d2ed4e3c4cfffeb57c2efc1becc0cf421f8f864e7b0284809fcac7863fe8201f47d8bd48ac0879796ffba9b64c8fd001a6a83bfb989671ece19ffd50c6fd0760efa8eea0788ab9f4d10df697ed1cb5e58c91c90d72ffe3d86447c19628d2efa86518e572b00c436f17671fca1beb8c77c74e9690ac111197b14f526d88e02da145dd629a7b5a6a7038b548680830b9c9fdb7aebfe927f3889e7f083f27d20ca7ad4ee698fdd2047f77d5bab199
解密后报文
XML
<?xml version="1.0" encoding="UTF-8" ?>
<data_content>
<terminal_id>10001</terminal_id>
<member_id>100000362</member_id>
<trans_id>1236546587</trans_id>
<trade_date>20160425181400</trade_date>
<succ_amt>1</succ_amt>
<resp_code>0000</resp_code>
<resp_msg>交易成功</resp_msg>
<trans_no>201508060110000524183254</trans_no>
</data_content>
JSON
{
"terminal_id":"10001",
"member_id":"100000362",
"trans_id":"1236546587",
"trade_date":"20160425181400",
"succ_amt":"1",
"resp_code":"0000",
"resp_msg":"交易成功",
"trans_no":"201508060110000524183254"
}
加密数据
请求响应结果解密后的报文格式需提前联系技术支持进行配置(现支持JSON和XML),输出内容包括
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 应答码 | resp_code | M | 具体参见附录:应答码 |
2 | 应答信息 | resp_msg | M | 填写具体的应答信息 |
3 | 商户号 | member_id | R | 宝付提供给商户的唯一编号 |
4 | 终端号 | terminal_id | R | |
5 | 订单发送时间 | trade_date | R | |
6 | 商户订单号 | trans_id | R | |
7 | 宝付交易号 | trans_no | M | 由宝付返回,用于在后续类交易中一笔交易的唯一标识 |
8 | 成功金额 | succ_amt | M | 交易成功后返回的金额,单位:分 |
9 | 批次号 | batch_id | M | |
10 | 商户保留域 | req_reserved | O | |
11 | 订单状态 | order_stat | M | |
12 | 商户批次号 | trans_batch_id | R |
返回值 | 参数说明 |
---|---|
OK | 成功接收到宝付支付结果时返回OK, *注:宝付将接受返回的字符自动去除前空格,为兼容文件格式差异, 宝付会匹配前5个字符,包含OK的,则认为商户接受OK,否则按照规则补发通知。 |
- 注:
宝付将掉单或超时的订单取出,补发支付结果(结果有成功和失败,不是仅仅发支付成功的订单,请商户务必要根据应答码判断支付结果是成功还是失败,再进行正确的处理),以GET和POST方式发送到商户配置的接收地址,商户接收到支付结果,并且进行相应处理之后,需要商户接收通知的地址在页面上输出 OK 表示接收成功<除了 OK 无任何其他内容>,告诉宝付已经成功接收并处理完毕,宝付系统在未得到商户接收通知成功的反馈时,将通过重发机制再次通知商户(重发次数 2~10 次,请以第一次收到的支付成功的消息为准,避免进行多次充值或支付),直到商户接收成功或达到最大重发次数为止。
2.1.16 批量新代收批次查询
商户可通过该接口向我司发起批量查询请求,查询该批次中每笔订单状态,根据返回的信息明确判断订单是否支付成功。
交易URL
测试环境地址:https://vgw.baofoo.com/batchpay/api/batchTransRequest
正式环境地址:https://public.baofoo.com/batchpay/api/batchTransRequest
请求报文
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 版本号 | version | M | 4.0.0.2(请使用此固定版本号) |
2 | 终端号 | terminal_id | M | |
3 | 交易类型 | txn_type | M | 取值:0631 |
4 | 交易子类 | txn_sub_type | M | 取值:19 |
5 | 商户号 | member_id | M | |
6 | 加密数据类型 | data_type | M | data_type =xml或json |
7 | 加密数据 | data_content | M | 具体参数如下加密数据 |
加密数据
序号 | 域名 | 变量名 | 必填 | 备注 |
---|---|---|---|---|
1 | 交易子类 | txn_sub_type | M | 见附录:交易类型枚举 |
2 | 终端号 | terminal_id | M | |
3 | 商户号 | member_id | M | 宝付提供给商户的唯一编号 |
4 | 商户流水号 | trans_serial_no | M | 8-50 位字母和数字,每次请求都不可重复 |
5 | 批次号 | batch_id | O | 宝付提供给商户的支付批次编号 |
6 | 商户批次号 | trans_batch_id | O | 优先采用商户批次号查询,当其为空或NUL时,使用宝付批次号,与宝付批次号二者至少必输其一 |
加密数据模板:
XML
<?xml version="1.0" encoding="UTF-8" ?>
<data_content>
<txn_sub_type>19</txn_sub_type>
<terminal_id>10001</terminal_id>
<member_id>100000362</member_id>
<trans_serial_no>1236546587654</trans_serial_no>
<batch_id>32143434</ batch_id>
<trans_batch_id>TX213213</trans_batch_id >
</data_content>
JSON
{
"txn_sub_type":"06",
"terminal_id":"10001",
"member_id":"100000362",
"trans_serial_no":"1236546587654",
"batch_id":"32143434",
"trans_batch_id":"TX213213"
}
应答报文(宝付返回报文)
支付响应结果由宝付通过非对称加密公私钥方式发送给商户。商户接收到宝付的响应报文,将接收到的内容,用宝付发给商户且后缀为(*.cer)的公钥证书进行解密。
应答结果解密后的报文格式是根据原交易订单请求的“data_type”来决定,输出内容包括
序号|域名|变量名|必填|备注
-|-|-|-|-
1|应答码| resp_code| M| 具体参见附录:应答码
2|应答信息| resp_msg |M |填写具体的应答信息
3|商户号| member_id| M |宝付提供给商户的唯一编号
4|终端号 |terminal_id| M|
5|数据域| actual_info| R |实际信息
实际信息说明:actual_info为实际信息集合,子节点为info, 字段分割顺序如下:
trans_id#order_stat# resp_code# resp_msg# trans_no# succ_amt#req_reserved
各字段具体介绍如下
序号|域名|变量名|必填|备注
-|-|-|-|-
1|商户订单号 |trans_id| M |
2|交易状态 |order_stat |M| I-处理中 S-成功 F-失败
3|应答码 |resp_code| M |具体参见附录:应答码
4|应答信息 |resp_msg| M |填写具体的应答信息
5|宝付交易号| trans_no| C| 由宝付返回,用于在后续类交易中一笔交易的唯一标识
6|成功金额| succ_amt| C| 交易成功后返回的金额,单位:元
7|请求方保留域| req_reserved| R |
XML
<?xml version="1.0" encoding="utf-8"?>
<result>
<resp_code>0000</resp_code>
<resp_msg>查询成功</resp_msg>
<member_id>100000749</member_id>
<terminal_id>100000933</terminal_id>
<actual_info>
<info>20160724143920100#S#0000#交易成功#201607260110000600022065#1.00#</info>
<info>20160724143920101#S#0000#交易成功#201607260110000600022066#1.00#</info>
<info>20160724143920102#S#0000#交易成功#201607260110000600022067#1.00#</info>
</actual_info>
</result>
JSON
{
"actual_info": {
"info": [
"20160724143920100#S#0000#交易成功#201607260110000600022065#1.00#",
"20160724143920101#S#0000#交易成功#201607260110000600022066#1.00#",
"20160724143920102#S#0000#交易成功#201607260110000600022067#1.00#",
"20160724143920103#S#0000#交易成功#201607260110000600022068#1.00#"
]
},
"member_id": "100000749",
"resp_code": "0000",
"resp_msg": "查询成功",
"terminal_id": "100000933"
}
3. 附录1 新代收保留域
3.1 新代收保留域字段说明
序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
---|---|---|---|---|---|
1 | 新业务类型 | entrust_business_type | M | Max10Text | 详见新代收业务类种类编码 |
2 | 新代收最高限额 | entrust_amt_limit | M | Max12Numeric | 单位:分,例:1元则提交100 |
3 | 新代收收单起始时间 | entrust_start_time | M | ISODateTime | 新代收收单起始时间,如2017-12-19 20:19:19 |
4 | 新代收结束时间 | entrust_end_time | M | ISODateTime | 新代收结束时间,如2017-12-19 20:19:19 |
5 | 新代收时间周期 | entrust_date_cycle | M | Max4Text | 详见附录新代收收款周期 |
6 | 新代收时间描述 | entrust_date_desc | O | Max200Text | |
7 | 新代收频率 | entrust_frequency | M | Max4Numeric | 表示周期内成功扣款次数 |
3.2 新代收保留域数据字典
3.2.1 新代收业务类种类编码
支付场景 | 业务类型 | 商户业务种类编码 | 代扣业务分类 |
---|---|---|---|
公共便民服务 | 水电煤缴费 | 110001 | A类 |
公共便民服务 | 税费缴纳 | 110002 | A类 |
公共便民服务 | 非营利性交易缴费 | 110003 | A类 |
公共便民服务 | 医疗缴费 | 110004 | A类 |
公共便民服务 | 罚款缴纳 | 110005 | A类 |
公共便民服务 | 路桥通行缴费 | 110006 | A类 |
公共便民服务 | 邮政缴费 | 110007 | A类 |
公共便民服务 | 电视账单缴费 | 110008 | A类 |
公共便民服务 | 话费账单缴费 | 110009 | A类 |
公共便民服务 | 宽带账单缴费 | 110010 | A类 |
公共便民服务 | 公益捐款 | 110011 | A类 |
公共便民服务 | 政府服务 | 110012 | A类 |
公共便民服务 | 财政非税收入 | 110013 | A类 |
公共便民服务 | 营利性教育培训 | 110014 | A类 |
公共便民服务 | 公共交通 | 110015 | A类 |
公共便民服务 | 物业缴费 | 110017 | A类 |
公共便民服务 | 国库经收 | 110018 | A类 |
公共便民服务 | 其他公共服务 | 110099 | A类 |
商业及金融服务 | 基金申购 | 120001 | A类 |
商业及金融服务 | 基金认购 | 120002 | A类 |
商业及金融服务 | 保险购买或缴费 | 120003 | A类 |
商业及金融服务 | 贷款或还款 | 120004 | A类 |
商业及金融服务 | 信用卡还款 | 120015 | A类 |
商业及金融服务 | 融资租赁 | 120016 | A类 |
商业及金融服务 | 其他商业及金融服务 | 120099 | |
资金归集 | 集团资金归集 | 150001 | A类 |
资金归集 | 供应链资金归集 | 150002 | A类 |
对公业务 | 一 | 200000 |
3.2.2 新代收收款周期
编码类型 | 收款周期 |
---|---|
0001 | 年 |
0403 | 季 |
0401 | 月 |
0707 | 周 |
0701 | 日 |
4. 附录2 风控参数字段说明
4.1 风控参数字段说明
通用参数
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | goodsCategory | 行业类目 | String | M | 参见数据字典“行业类目” |
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 | 生成设备指纹的订单号(用于快捷),如果和支付订单号一致,传相同的值 |
电商
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | csName | 收货人姓名 | String | M | |
2 | csMobile | 收货人手机 | String | M | 不包含电话国家码的本地号码 |
3 | csAreaCode | 收货人区号 | String | O | 如右边举例代表上海 021 |
4 | csTel | 收货人电话 | String | O | 不包含电话国家码的本地固化号码 |
5 | csIdType | 收货人证件类型 | String | O | 00-身份证;01-护照;02-军官证;03-士兵证;04-港澳台通行证;05-临时身份证;06-户口本;07-警官证;08-外国人居留证;09-回乡证;10-企业营业执照;11-法人代码证;12-台胞证;13-外交官证;14-文职干部或离休干部证明;15-学生证(16周岁以下未成年人);99-其他 |
6 | csIdNo | 收货人证件号码 | String | O | |
7 | csProvince | 收货人省份 | String | M | 参见我司省份代码 |
8 | csCity | 收货人城市 | String | M | 参见我司城市代码 |
9 | csAddress | 收货人地址 | String | M | 不包含国家、省份/州、城市信息的详细地址 |
10 | prodNameList | 商品名称 | String | M | 多种商品,半角分号分隔 |
11 | prodTypeList | 商品类目 | String | M | 多种商品规则同上 |
12 | prodQtyList | 商品数量 | String | M | 多种商品规则同上 |
13 | prodAmtList | 商品总价 | String | M | 数字 (15位总长度,2位小数),多种商品规则同上 |
14 | regAddress | 会员注册信息中的地址 | String | O | |
15 | prodUrl | 商户url | String | O | 商户产品的url |
互金消金
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | tradeType | 交易类型 | String | O | 1-充值 2-还款 3-投标 |
2 | customerType | 用户类型 | String | O | 1-投资人 2-借款人 |
3 | hasBalance | 商户会员账户是否有余额 | String | O | 0-否 1-是 |
4 | hasBindCard | 商户会员是否绑定银行卡 | String | O | 0-否 1-是 |
5 | repaymentDate | 到期还款日 | String | O | 交易类型若为2 YYYYMMDDHHMMSS |
6 | lendingRate | 借款利率 | String | O | 交易类型若为2 例:10.5% |
7 | bidYields | 标的收益率 | String | O | 交易类型若为3 例:8.5% |
8 | latestTradeDate | 账户前一次交易日期 | String | O | 0-首次 YYYYMMDDHHMMSS |
航旅
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | tbPName | 乘机人姓名 | String | M | 多个乘机人之间用半角分号分隔,例:张三;李四;王二 |
2 | tbPTel | 乘机人电话 | String | O | 多个乘机人规则同上;FGW网关交易中与手机信息合并在该字段中 |
3 | tbPMobile | 乘机人手机 | String | M | 多个乘机人规则同上 |
4 | tbPEmail | 乘机人邮箱 | String | M | 多个乘机人规则同上 |
5 | tbPIdType | 乘机人证件类型 | String | M | 00-身份证;01-护照;02-军官证;03-士兵证;04-港澳台通行证;05-临时身份证;06-户口本;07-警官证;08-外国人居留证;09-回乡证;10-企业营业执照;11-法人代码证;12-台胞证;13-外交官证;14-文职干部或离休干部证明;15-学生证(16周岁以下未成年人);99-其他;多个乘机人规则同上 |
6 | tbPIdNo | 乘机人证件号码 | String | M | 多个乘机人规则同上 |
7 | tbPNantionality | 乘机人国籍 Customer Nantionality | String | M | 使用2位字母ISO代码;多个乘机人规则同上 |
8 | tbPIsFrequenter | 是否常旅客 | String | M | N-否,Y-是;多个乘机人规则同上 |
9 | tbFlight | 航班号flight number | String | M | |
10 | tbPTicketQty | 机票数量 Quantity | String | M | 正整数 |
11 | tbTotalAmt | 机票总价 Product Total Price (账单金额) | String | M | 数字 (15位总长度,2位小数) |
12 | tbDetail1 | 机票细节1(航空公司)Product Detail1 (Airline Name) | String | M | |
13 | tbDetail2 | 机票细节2(机票类座位等级)Product Detail2 (classes for arilines) | String | M | |
14 | tbIsSingleTrip | 是否单程 | String | M | N-往返,Y-单程; |
15 | tbOffState | 起飞国家 | String | M | 国际ISO标准的2位字符国家名称 |
16 | tbTagetState | 目的国家 | String | M | 国际ISO标准的2位字符国家名称 |
17 | tbDepTime | 起飞时间 | String | M | YYYYMMDDhhmmss要求传输北京时间 |
18 | tbDepAirport | 起飞机场Departure Airport | String | M | 参考国际航空运输协会(IATA)三位机场代码定义,例:PEK-北京市首都机场,SHA-上海市虹桥机场,PVG-上海市虹桥机场 |
19 | tbArrivalAirport | 降落机场 Arrival Airport | String | M | 同上 |
20 | tbTransitAirport | 中转机场 Transit Airport | String | M | 若有,格式标准同上;可支持多个中转机场,半角分号分隔 |
21 | tbLeadtime | 收发时间差 Lead Time 订票时间和登机时间的时间差,单位是天 | String | M | |
22 | tbReceiptAddress | 收取行程单地址 | String | O | 如为国外地址为包含国家名称的详细地址 |
酒店
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | htGuestName | 入住人姓名 | String | M | 多个入住人之间用半角分号分隔,例:张三;李四;王二 |
2 | htGuestPhone | 入住人手机或电话 | String | M | 多个入住人规则同上 |
3 | htGuestIdType | 入住人证件类型 | String | M | 00-身份证;01-护照;02-军官证;03-士兵证;04-港澳台通行证;05-临时身份证;06-户口本;07-警官证;08-外国人居留证;09-回乡证;10-企业营业执照;11-法人代码证;12-台胞证;13-外交官证;14-文职干部或离休干部证明;15-学生证(16周岁以下未成年人);99-其他;多个入住人规则同上 |
4 | htGuestIdNo | 入住人证件号码 | String | M | 多个入住人规则同上 |
5 | htBrand | 酒店名称 | String | M | |
6 | htLocalProvince | 酒店所在省份 | String | M | 参见我司省份代码 |
7 | htLocalCity | 酒店所在城市Nantionality | String | M | 参见我司城市代码 |
8 | htLocalStreet | 酒店所在地址 | String | M | 不包含国家、省份/州、城市信息的详细地址 |
9 | htRoomType | 房间类型 | String | M | |
10 | htCheckinTime | 入住起始时间 | String | M | YYYYMMDDhhmmss |
11 | htCheckoutTime | 入住终止时间 | String | M | YYYYMMDDhhmmss |
保险
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | applicantName | 投保人姓名 | String | M | |
2 | applicantAddr | 投保人居住地址 | String | O | |
3 | applicantIdCard | 投保人身份证号码 | String | O | |
4 | applicantMobile | 投保人手机号 | String | M | |
5 | insuredName | 被保险人姓名 | String | O | |
6 | insuredAddr | 被保险人居住地址 | String | O | |
7 | insuredIdCard | 被保险人身份证号码 | String | O | |
8 | insuredMobile | 被保险人手机号 | String | O | |
9 | beneficiaryName | 受益人姓名 | String | O | |
10 | beneficiaryAddr | 受益人居住地址 | String | O | |
11 | beneficiaryIdCard | 受益人身份证号 | String | O | |
12 | beneficiaryMobile | 受益人手机号 | String | O | |
13 | insuranceType | 保险险种 | String | M | |
14 | insuranceMoney | 保额 | String | O | |
15 | premium | 保费 | String | O | |
16 | payPeriod | 缴费年限 | String | O |
游戏
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | gameName | 充值游戏名称 | String | M | |
2 | userAcctId | 游戏账户ID | String | M | |
3 | rechargeType | 充值类型 | String | M | 0:为本账户充值或支付;1:为他人账户充值或支付;默认为 0 |
4 | gameProdType | 游戏商品类型 | String | M | 01:点券类 02:金币类 03:装备道具类 04:其他 |
5 | gameAcctId | 被充值游戏账户ID | String | M | 若充值类型为1 |
6 | gameLoginTime | 游戏登录次数 | String | M | 累计最近一个月 |
7 | gameOnlineTime | 游戏在线时长 | String | M | 累计最近一个月 |
大宗
序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
---|---|---|---|---|---|
1 | btType | 交易类型 | String | M | 01:证券交易 02:期货交易 03:贵金属交易 04:期权交易 05:外汇交易 06:大宗商品交易 07:邮币卡 |
2 | btUserIdType | 用户注册证件类型 | String | O | 00-身份证;01-护照;02-军官证;03-士兵证;04-港澳台通行证;05-临时身份证;06-户口本;07-警官证;08-外国人居留证;09-回乡证;10-企业营业执照;11-法人代码证;12-台胞证;13-外交官证;14-文职干部或离休干部证明;15-学生证(16周岁以下未成年人);99-其他 |
3 | btUserIdNo | 用户注册证件号码 | String | M | |
4 | btProvince | 交易人省份 | String | M | 参见我司省份代码 |
5 | btCity | 交易人城市 | String | M | 参见我司城市代码 |
6 | btAddress | 交易人地址 | String | M | 不包含国家、省份/州、城市信息的详细地址 |
7 | btProdName | 商品名称 | String | M | |
8 | btAcctType | 账户类型 | String | M | 参见数据字典“帐户类型” |
4.2 风控参数数据字典
商品类目(prodTypeList)
代码 | 中文名称(商品类型) |
---|---|
001 | 家用电器 |
002 | 手机/运营商/数码 |
003 | 电脑/办公 |
004 | 家居/家具/家装/厨具 |
005 | 男装/女装/童装/内衣 |
006 | 美妆个护/宠物 |
007 | 女鞋/箱包/钟表/珠宝 |
008 | 男鞋/运动/户外 |
009 | 汽车/汽车用品 |
010 | 母婴/玩具乐器 |
011 | 食品/酒类/生鲜/特产 |
012 | 礼品鲜花/农资绿植 |
013 | 医药保健/计生情趣 |
014 | 图书/音像/电子书 |
015 | 机票/酒店/旅游/生活 |
016 | 理财/众筹/白条/保险 |
行业类目(goodsCategory)
代码 | 中文名称(商品类目) |
---|---|
01 | 电商 |
02 | 互金消金 |
03 | 航旅 |
04 | 酒店 |
05 | 保险 |
06 | 游戏 |
07 | 大宗 |
证件类型
证件 | 编号 |
---|---|
身份证 | 00 |
护照 | 01 |
军官证 | 02 |
士兵证 | 03 |
港澳台通行证 | 04 |
临时身份证 | 05 |
户口本 | 06 |
警官证 | 07 |
外国人居留证 | 08 |
回乡证 | 09 |
企业营业执照 | 10 |
法人代码证 | 11 |
台胞证 | 12 |
外交官证 | 13 |
文职干部或离休干部证明 | 14 |
学生证(16周岁以下未成年人) | 15 |
其他 | 99 |
交易类型(btType)
代码 | 中文名称(交易类型) |
---|---|
04 | 证券交易 |
05 | 期货交易 |
06 | 贵金属交易 |
07 | 期权交易 |
08 | 外汇交易 |
09 | 大宗商品交易 |
10 | 邮币卡 |
11 | 其他 |
帐户类型(btAcctType)
代码 | 中文名称(帐户类型) |
---|---|
04 | 股票账户 |
05 | 基金帐户 |
06 | 大宗交易帐户(投资人帐户) |
07 | 期货帐户 |
08 | 其他帐户 |
国家代码
编码 | 名称 |
---|---|
AE | 阿联酋(UNITED EMIRATES) |
AF | 阿富汗(AFGHANISTAN) |
AL | 阿尔巴尼亚(ALBANIA) |
AM | 亚美尼亚(ARMENIA) |
AO | 安哥拉(ANGOLA) |
AR | 阿根廷(ARGENTINA) |
AT | 奥地利(AUSTRIA) |
AU | 澳大利亚(AUSTRALIA) |
AZ | 阿塞拜疆(AZERBAIJAN(REPUBLIC)) |
BD | 孟加拉(BANGLADESH) |
BE | 比利时(BELGIUM) |
BF | 布基纳法索(BURKINA FASO) |
BG | 保加利亚(BULGARIA) |
BH | 巴林(BAHREIN) |
BI | 布隆迪(BURUNDI) |
BJ | 贝宁(BENIN) |
BL | 巴勒斯坦() |
BN | 文莱(BRUNEI DARUSSALAM) |
BO | 玻利维亚(BOLIVIA) |
BR | 巴西(BRAZIL) |
BW | 博茨瓦纳(BOTSWANA) |
BY | 白俄罗斯(BYELORUSSIA) |
CA | 加拿大(CANADA) |
CF | 中非(CENTRAL AFRICA) |
CG | 刚果(CONGO) |
CH | 瑞士(SWITZERLAND) |
CL | 智利(CHILE) |
CM | 喀麦隆(CAMEROON) |
CN | 中国(CHINA) |
CO | 哥伦比亚(COLOMBIA) |
CR | 哥斯达黎加(COSTA RICA) |
CS | 捷克(CZECH REPUBIC) |
CU | 古巴(CUBA) |
CY | 塞浦路斯(CYPRUS) |
DE | 德 国(GERMANY) |
DK | 丹麦(DENMARK) |
DO | 多米尼加共和国(DOMINICAN REPUBLIC) |
DZ | 阿尔及利亚(ALGERIA) |
EC | 厄瓜多尔(ECUADOR) |
EE | 爱沙尼亚(ESTONIA) |
EG | 埃及(EGYPT) |
ES | 西班牙(SPAIN) |
ET | 埃塞俄比亚(ETHIOPIA) |
FI | 芬兰(FINLAND) |
FJ | 斐济(FIJI) |
FR | 法国(FRANCE) |
GA | 加蓬(GABON) |
GB | 英国(UNITED KINGDOM) |
GD | 格林纳达(GRENADA) |
GE | 格鲁吉亚(GEORGIA) |
GH | 加纳(GHANA) |
GN | 几内亚(GUINEA) |
GR | 希腊(GREECE) |
GT | 危地马拉(GUATEMALA) |
HK | 香港特别行政区(HONG KONG) |
HN | 洪都拉斯(HONDURAS) |
HU | 匈牙利(HUNGARY) |
ID | 印度尼西亚(INDONESIA) |
IE | 爱尔兰(IRELAND) |
IL | 以色列(ISRAEL) |
IN | 印度(INDIA) |
IQ | 伊拉克(IRAQ) |
IR | 伊朗(IRAN) |
IS | 冰岛(ICELAND) |
IT | 意大利(ITALY) |
JM | 牙买加(JAMAICA) |
JO | 约旦(JORDAN) |
JP | 日本(JAPAN) |
KG | 吉尔吉斯坦(KYRGYZSTAN) |
KH | 柬埔寨(KAMPUCHEA(CAMBODIA)) |
KP | 北朝鲜(KOREA,DEM.PEOPLE’S) |
KR | 韩国(REPUBLIC OF KOREA) |
KT | 科特迪瓦共和国(COTE O’IVOIRE) |
KW | 科威特(KUWATI) |
KZ | 哈萨克(KAZAKHSTAN) |
LA | 老挝(LAOS) |
LB | 黎巴嫩(LEBANON) |
LC | 圣卢西亚(SAINT LUEIA) |
LI | 列支敦士登(LIECHTENSTEIN) |
LK | 斯里兰卡(SRI LANKA) |
LR | 利比里亚(LIBERIA) |
LT | 立陶宛(LITHUANIA) |
LU | 卢森堡(LUXEMBOURG) |
LV | 拉脱维亚(LATVIA) |
LY | 利比亚(LIBYAN) |
MA | 摩洛哥(MOROCCO) |
MC | 摩纳哥(MONACO) |
MD | 摩尔多瓦(MOLDOVA,REPUBLIC OF) |
MG | 马达加斯加(MADAGASCAR) |
ML | 马里(MALI) |
MM | 缅甸(BURMA(MYANMAR)) |
MN | 蒙古(MONGOLIA) |
MO | 澳门地区(MACAU) |
MT | 马耳他(MALTA) |
MU | 毛里求斯(MAURITIUS) |
MW | 马拉维(MALAWI) |
MX | 墨西哥(MEXICO) |
MY | 马来西亚(MALAYSIA) |
MZ | 莫桑比克(MOZAMBIQUE) |
NA | 纳米比亚(NAMIBIA) |
NE | 尼日尔(NIGER) |
NG | 尼日利亚(NIGERIA) |
NI | 尼加拉瓜(NICARAGUA) |
NL | 荷兰(NETHERLANDS) |
NO | 挪威(NORWAY) |
NP | 尼泊尔(NEPAL) |
NZ | 新西兰(NEW ZEALAND) |
OM | 阿曼(OMAN) |
PA | 巴拿马(PANAMA) |
PE | 秘鲁(PERU) |
PG | 巴布亚新几内亚(PAPUA NEW GUINEA) |
PH | 菲律宾(PHILIPPINES) |
PK | 巴基斯坦(PAKISTAN) |
PL | 波兰(POLAND) |
PT | 葡萄牙(PORTUGAL) |
PY | 巴拉圭(PARAGUAY) |
QA | 卡塔尔(QATAR) |
RO | 罗马尼亚(ROMANIA) |
RU | 俄罗斯(RUSSIAN FEDERATION) |
SA | 沙特阿拉伯(SAUDI ARABIA) |
SC | 塞舌尔(SEYCHELLES) |
SD | 苏丹(SUDAN) |
SE | 瑞典(SWEDEN) |
SG | 新加坡(SINGAPORE) |
SI | 斯洛文尼亚(SLOVENIA) |
SK | 斯洛伐克(SLOVAKIA) |
SM | 圣马力诺(SAN MARINO) |
SN | 塞内加尔(SENEGAL) |
SO | 索马里(SOMALIA) |
SY | 叙利亚(SYRIA) |
SZ | 斯威士兰(SWAZILAND) |
TD | 乍得(CHAD) |
TG | 多哥(TOGO) |
TH | 泰国(THAILAND) |
TJ | 塔吉克斯坦(TAJIKISTAN) |
TM | 土库曼(TURKMENISTAN) |
TN | 突尼斯(TUNISIA) |
TR | 土耳其(TURKEY) |
TW | 台湾省(TAIWAN) |
TZ | 坦桑尼亚(TANZANIA) |
UA | 乌克兰(UKRAINE) |
UG | 乌干达(UGANDA) |
US | 美国(UNITED STATES) |
UY | 乌拉圭(URUGUAY) |
UZ | 乌兹别克(UZBEKISTAN) |
VC | 圣文森特岛(SAINT VINCENT) |
VE | 委内瑞拉(VENEZUELA) |
VN | 越南(VIET NAM) |
YE | 也门(YEMEN) |
YU | 南斯拉夫联盟(YUGOSLAVIA) |
ZA | 南非(SOUTH AFRICA) |
ZM | 赞比亚(ZAMBIA) |
ZR | 扎伊尔(ZAIRE) |
ZW | 津巴布韦(ZIMBABWE) |
机场代码
参照国际航空运输协会规定的3位机场代码,国际通用代码,因此每家商户都一致。
省份,区域代码
参照我司省份、区域代码表
5. 附录3(规范性附录)数据元类型
5.1 交易类型枚举
交易子类 | 交易描述 |
---|---|
101 | 预绑卡类交易 |
102 | 确认绑卡类交易 |
103 | 查询绑定关系类交易 |
104 | 解除绑卡类交易 |
105 | 预支付类交易 |
106 | 确认支付类交易 |
107 | 订单查询类交易 |
108 | 直接支付类交易 |
109 | 分账预绑卡类交易 |
110 | 分账确认绑卡类交易 |
111 | 分账查询绑定关系类交易 |
112 | 分账预支付类交易 |
113 | 分账确认支付类交易 |
114 | 分账直接支付类交易 |
115 | 分账订单查询类交易 |
116 | 组合支付直接支付类交易 |
117 | 组合支付订单查询类交易 |
118 | 分账组合支付直接支付类交易 |
119 | 分账组合支付订单查询类交易 |
120 | 批量新代收预绑卡类交易 |
121 | 批量新代收确认绑卡类交易 |
122 | 批量新代收查询绑定关系类交易 |
123 | 批量新代收类交易 |
124 | 批量新代收单笔订单查询类交易 |
125 | 批量新代收批次查询类交易 |
126 | 分账批量新代收预绑卡类交易 |
127 | 分账批量新代收确认绑卡类交易 |
128 | 分账批量新代收查询绑定关系类交易 |
129 | 分账批量新代收类交易 |
130 | 分账批量新代收单笔订单查询类交易 |
131 | 分账批量新代收批次查询类交易 |
5.2 卡类型枚举-card_type
类型编码 | 含义 |
---|---|
101 | 借记卡 |
102 | 信用卡 |
103 | 企业对公账户 |
5.3 证件类型枚举-id_card_type
交易类型 | 身份证 |
---|---|
01 | 身份证 |
12 | 港澳居民居住证 |
13 | 台湾居民居住证 |
5.4 银行编码
银行代码 | 银行名称 |
---|---|
ICBC | 中国工商银行 |
ABC | 中国农业银行 |
CCB | 中国建设银行 |
BOC | 中国银行 |
BCOM | 中国交通银行 |
CIB | 兴业银行 |
CITIC | 中信银行 |
CEB | 中国光大银行 |
PAB | 平安银行 |
PSBC | 中国邮政储蓄银行 |
SHB | 上海银行 |
SPDB | 浦东发展银行 |
CMBC | 中国民生银行 |
CMB | 招商银行 |
GDB | 广发银行 |
6. 附录4(规范性附录)返回码信息
6.1 商户接口应答码
应答码 | 含义 |
---|---|
S | 成功 |
F | 失败 |
I | 处理中 |
FF | 失败(支付结果查询类交易才会返回,表示订单查询参数错误或其他原因导致的订单查询失败,而非订单交易失败) |
6.2 业务应答码
最后编辑:xiaofeng 更新时间:2025-01-09 17:41