- 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.2 业务接口
- 2.2.1活动号支付
- 交易URL
- 请求报文
- 返回报文
- 2.2.2 支付结果查询类交易
- 交易URL
- 请求报文
- 返回报文
- 2.2.3 交易结果异步通知
- 返回报文
- 3 附录
- 业务应答码
- 银行编码
- 交易类型枚举
- 商户接口枚举类型
- A1、卡类型- card_type
- A2、证件类型- id_card_type
- 商户接口应答码
- 风控参数字段说明
- 通用参数
- 电商
- 互金消金
- 航旅
- 酒店
- 保险
- 游戏
- 大宗
- 风控参数数据字典
- 商品类目(prodTypeList)
- 行业类目(goodsCategory)
- 证件类型
- 交易类型(btType)
- 帐户类型(btAcctType)
- 国家代码
- 机场代码
- 省份,区域代码
1 文档说明
1.1 文档目的
本文档是为宝付协议支付API产品定义一个接口规范,以帮助商户技术人员快速接入宝付协议支付API网关,并快速掌握其相关功能,便于尽快的投入使用。
1.2 阅读对象
- 商户开发人员、维护人员和管理人员
- 宝付协议支付API产品相关的技术人员
1.3 技术支持
在开发或使用宝付协议支付API接口时,如果您有任何技术上的疑问,请按如下方式寻求帮助,宝付技术支持人员会及时处理,给予您答复:
技术支持热线: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 应用场景
宝付协议支付API产品是持卡人在商户平台购买服务或商品时,通过互联网将卡信息和身份信息提供给商户,商户在得到持卡人授权后,委托宝付从银行卡中将相应款项扣除,以满足商户的银行卡支付的业务需求。
注:该接口为后台指令模式
目前银行要求在商户平台页面上挂持卡人与银行之间的服务协议(快捷支付、协议支付),用户在绑卡时需要用户详细阅读并同意协议,才可以提供协议支付服务。各家银行的协议内容不一样,已经放到接口包里。如果不清楚可联系技术支持。银行挂网协议材料点击下载
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 | 固定值:166(见附录:交易类型枚举) |
| 6. | 商户号 | member_id | M | Max11Numeric | 宝付提供给商户的唯一编号 |
| 7. | 商户订单号 | trans_id | M | Max50Text | 唯一订单号,8-50 位字母和数字,未支付成功的订单号可重复提交,重复提交时交易参数不得发生变化 |
| 8. | 活动编号 | activity_id | O | 宝付提供 | |
| 9. | 数字信封 | dgtl_envlp | M | Max512Text | 格式:01|对称密钥,01代表AES;加密方式:Base64转码后使用宝付的公钥加密 |
| 10. | 签约协议号 | protocol_no | M | Max126Text | 加密方式:Base64转码后,使用数字信封指定的方式和密钥加密 |
| 11. | 交易金额 | txn_amt | M | Max12Numeric | 单位:分;例:1元则提交100 |
| 12. | 风控参数 | risk_item | M | 不限制 | Json格式,详细参数见风控参数字段说明(通用参数、电商、互金消金、航旅、酒店、宝信、游戏、大宗) |
| 13. | 交易成功通知地址 | return_url | O | Max500Text | 最多填写三个地址;不同的地址用‘|’连接 |
| 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 |
返回报文
| 序号 | 域名 | 变量名 | 必填 | 字段类型 | 备注 |
|---|---|---|---|---|---|
| 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. | 订单金额 | order_amt | C | Max12Numeric | 单位:分;例:1元则100 |
| 12. | 活动金额 | activity_amt | C | Max12Numeric | 单位:分;例:1元则100 |
| 13. | 成功时间 | succ_time | C | ISODateTime | 支付成功时间 |
| 14. | 活动不匹配原因 | mismatch_reason | C | Max255Text | |
| 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 | |
| 22. | 渠道订单号 | channel_order_id | O | Max64Text | |
| 23. | 活动编号 | activity_id | R | Max32Text |
2.2.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 | 固定值:07(见附录:交易类型枚举) |
| 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:商户接口应答码 |
| 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 | |
| 19 | 渠道订单号 | channel_order_id | O | Max64Text | 默认不返回 |
| 20. | 活动编号 | activity_id | C | Max32Text | |
| 21. | 订单金额 | order_amt | C | Max12Numeric | 单位:分;例:1元则100 |
| 22. | 活动金额 | activity_amt | C | Max12Numeric | 单位:分;例:1元则100 |
2.2.3 交易结果异步通知
如果直接支付类交易或预绑卡支付时上传了异步通知地址(return_url字段),当订单成功或失败时候会收到宝付的异步通知。异步通知以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 | 具体参见附录1:业务应答码 |
| 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 | |
| 11 | 渠道订单号 | channel_order_id | O | Max64Text | 默认不返回 |
| 12. | 活动编号 | activity_id | C | Max32Text | |
| 13. | 订单金额 | order_amt | C | Max12Numeric | 单位:分;例:1元则100 |
| 14. | 活动金额 | activity_amt | C | Max12Numeric | 单位:分;例:1元则100 |
3 附录
业务应答码
参考业务应答码列表
银行编码
| 银行代码 | 银行名称 |
|---|---|
| ICBC | 中国工商银行 |
| ABC | 中国农业银行 |
| CCB | 中国建设银行 |
| BOC | 中国银行 |
| BCOM | 中国交通银行 |
| CIB | 兴业银行 |
| CITIC | 中信银行 |
| CEB | 中国光大银行 |
| PAB | 平安银行 |
| PSBC | 中国邮政储蓄银行 |
| SHB | 上海银行 |
| SPDB | 浦东发展银行 |
| CMBC | 中国民生银行 |
| CMB | 招商银行 |
| GDB | 广发银行 |
交易类型枚举
| 交易类型 | 交易描述 |
|---|---|
| 01 | 协议支付预绑卡类交易 |
| 02 | 协议支付确认绑卡类交易 |
| 03 | 查询绑定关系类交易 |
| 04 | 协议支付解除绑卡类交易 |
| 05 | 协议支付预支付类交易 |
| 06 | 协议支付确认支付类交易 |
| 07 | 协议支付订单查询类交易 |
| 08 | 协议支付直接支付类 |
| 66 | 网关签约申请 |
| 67 | 网关签约预申请 |
| 68 | 网关确认签约 |
| 78 | 网关签约流水结果查询 |
商户接口枚举类型
A1、卡类型- card_type
| 类型编码 | 含义 |
|---|---|
| 101 | 借记卡 |
| 102 | 信用卡 |
A2、证件类型- id_card_type
| 类型编码 | 含义 |
|---|---|
| 01 | 身份证 |
| 12 | 港澳居民居住证 |
| 13 | 台湾居民居住证 |
商户接口应答码
| 应答码 | 含义 |
|---|---|
| S | 成功 |
| F | 失败 |
| I | 处理中 |
| FF | 失败(支付结果查询类交易才会返回,表示订单查询参数错误或其他原因导致的订单查询失败,而非订单交易失败) |
风控参数字段说明
通用参数
| 序号 | 字段 | 名称 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|---|
| 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 | 参见数据字典“帐户类型” |
风控参数数据字典
商品类目(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位机场代码,国际通用代码,因此每家商户都一致。
省份,区域代码
参照我司省份、区域代码表 –>查看下载
最后编辑:xiaofeng 更新时间:2025-10-23 15:00