目录
3.10一键绑卡/网关签约接口组
1 一键绑卡模式(免卡号)支持以下11个银行:农行、中行、邮储、建行、交行、华夏、广发、平安、浦发、民生,网商,兴业银行(如后续有新增支持银行会更新)
2 网关模式(需要填写4要素),仅支持招行借记卡
3 快捷签约招行网关测试环境网关页面是通联自己模拟。
4 如需兼容到微信小程序上,商户自己要去小程序配置兼容跳转链接的白名单,且用H5链接的方式,需要将客户的小程序校验文件文件加到签约H5的根目录下,测试环境把文件发送给xiegm@allinpay.com,生产的联系事业部提需求。
可配置签约结果通知地址(NOTIFYURL)和回跳地址(BACKURL),签约流程结束后,会按配置进行结果通知和页面回跳,方便商户获取签约结果并引导用户后续操作
|
序号 |
银行 |
借记卡 |
信用卡 |
|
1 |
农业银行 |
已支持 |
已支持 |
|
2 |
中国银行 |
已支持 |
|
|
3 |
邮储银行 |
已支持 |
已支持 |
|
4 |
建设银行 |
已支持 |
已支持 |
|
5 |
交通银行 |
已支持 |
|
|
6 |
华夏银行 |
已支持 |
|
|
7 |
广发银行 |
已支持 |
已支持 |
|
8 |
平安银行 |
已支持 |
已支持 |
|
9 |
招商银行(网关形式) |
已支持 |
|
|
10 |
浦发银行 |
已支持 |
已支持 |
|
11 |
民生银行 |
已支持 |
|
|
12 |
网商银行 |
已支持 |
|
|
13 |
兴业银行 |
已支持 |
3.10.1 一键绑卡/网关签约申请(310006)
3.10.1.1 接口功能
返回的URL生产的域名会存在两个 ,sft.allinpay.com 、tlt.allinpay.com,如需开通白名单的,两个域名都要加上;
商委网关签约生产域名 sft.allinpay.com、ucp.allinpay.com、tlt.allinpay.com、code.jquery.com、fonts.gstatic.com(这是收付通内部转发所需域名),t.cmbchina.com、mobile.cmbchina.com(这两个对应的银行的网关域名,后续如果变动,联系机构部);
3.10.1.2 请求报文
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310006 |
M |
|
|
VERSION |
版本 |
C(2) |
04 |
M |
||
|
DATA_TYPE |
数据格式 |
N(1) |
2:xml格式 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
0-9 0优先级最低,默认为5 |
M |
||
|
MERCHANT_ID |
商户代码 |
C(15) |
商户ID |
M |
||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
USER_PASS |
用户密码 |
C |
不校验,(无需填写或可置空) |
|||
|
REQ_SN |
交易批次号 |
C(40) |
M |
不重复流水 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
PROTOCOLREQ |
MERCHANT_ID |
商户代码 |
C(15) |
商户号ID |
M |
|
|
SUBMIT_TIME |
申请时间 |
C (14) |
YYYYMMDDHHMMSS |
M |
||
|
SIGN_MODE |
签约模式 |
C(1) |
1一键绑卡 2商委网关 3快捷网关 |
M |
目前签约模式2和3仅招行支持 |
|
|
BUSINESS_CODE |
业务代码 |
C(6) |
C |
当签约模式选择2商委网关时必填 |
||
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00银行卡,02信用卡。不填默认为银行卡00。 |
M |
|
|
|
BANK_CODE |
银行代码 |
C(8) |
银行代码,参见附录A.3银行代码 |
M |
||
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
借记卡或信用卡上的所有人姓名。 |
M |
||
|
ACCOUNT_NO |
账号 |
C(1,32) |
银行卡号 |
C |
当签约模式选择2商委网关和3快捷网关时必填 |
|
|
TEL |
手机号 |
C (1,13) |
手机号 |
C |
当签约模式选择2商委网关和3快捷网关时必填 |
|
|
ACCOUNT_PROP |
账号属性 |
C (1) |
0私人,1公司。不填时,默认为私人0。 |
M |
||
|
ID_TYPE |
开户证件类型 |
C (1) |
参考3.1 |
M |
||
|
ID |
证件号 |
C (1,22) |
M |
|||
|
MERREM |
商户保留信息 |
C (0,128) |
商户保留信息 |
C |
||
|
REMARK |
备注 |
C (1,50) |
供商户填入参考信息 |
C |
||
|
NOTIFYURL |
通知地址 |
C (0,256) |
C |
签约结果通知 |
||
|
BACKURL |
跳转地址 |
C (0,256) |
M |
触发签约回跳接口 |
||
|
RISKINFO |
DEVICE_MODE |
设备型号 |
C(1,256) |
设备型号名称 |
C |
|
|
DEVICE_LANGUAGE |
设备语言 |
C(3) |
设备语言,代码遵从ISO639-3标准 |
C |
||
|
SOURCEIP |
客户端IP |
C(1,64) |
C |
|||
|
MAC |
MAC地址 |
C(64) |
格式00-24-7E-0A-6C-2E或00247e0a6c2e |
C |
||
|
DEVICE_ID |
设备号 |
C(129) |
建议PC设备采集硬盘序列号、安卓系统设备采集IMEI、IOS设备采集IDFV |
C |
||
|
GPS |
GPS位置 |
C(1,32) |
经纬度,格式为维度/经度,+表示北纬、东经,-表示南纬、西经 举例:+37.12/-121.23 或者 +37/-121 |
C |
||
|
DEVICE_NUMBER |
SIM卡号码 |
C(1,32) |
存储11位手机号,存在2个通讯设备号码的话,用逗号分隔 |
C |
||
|
DEVICE_SIMNUM |
SIM卡数量 |
C(1,8) |
设备SIM卡数量 |
C |
||
|
ACCTIDHASH |
账户ID |
C(1,64) |
商户端用户支付时,如处于用户登录状态,提供商户系统中的用户ID |
C |
||
|
RISKSCORE |
风险评分 |
C(1,8) |
风险等级评分(0-1000分) |
C |
||
|
RISKREASONCODE |
风险评分的主要原因码 |
C(1,100) |
风险评分的主要原因码 |
C |
||
|
MCHNTUSRRGSTRTM |
收单端用户注册日期 |
C(14) |
收单端用户注册时间,14位时间字符yyyyMMddHHmmss |
C |
||
|
MCHNTUSRRGSTREMAIL |
收单端用户注册邮箱地址 |
C(1,64) |
收单端用户注册邮箱地址 |
C |
||
|
RCVPROVINCE |
收货省 |
C(1,4) |
收货地-省 上送银联清算地区代码 |
C |
||
|
RCVCITY |
收货市 |
C(1,4) |
收货地-市 上送银联清算地区代码 |
C |
||
|
GOODSCLASS |
商品类别 |
C(1) |
商品类别:0不确定 1虚拟 2非虚拟 |
C |
3.10.1.3 响应报文
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310006 |
M |
|
|
|
VERSION |
版本 |
C(2) |
03 |
M |
|
|
|
DATA_TYPE |
数据格式 |
N(1) |
2:xml格式 |
M |
|
|
|
REQ_SN |
交易批次号 |
C(40) |
|
M |
|
|
|
RET_CODE |
C(4) |
参考3.4 |
M |
|
|
|
|
ERR_MSG |
错误信息 |
C(1,256) |
|
C |
|
|
|
SIGNED_MSG |
签名信息 |
C |
|
M |
|
|
PROTOCOLRSP |
RET_CODE |
返回码 |
C(4) |
0000 |
C |
不是0000,重发请求 |
|
|
ERR_MSG |
错误文本 |
C(1,256) |
|
C |
|
|
|
SIGN_MODE |
签约模式 |
C(1) |
|
|
|
|
|
URL |
请求url |
C(1,256) |
|
C |
|
|
数字签名原文为没有SIGNED_MSG 签名信息项的xml全文。 |
||||||
3.10.1.3 例子
3.10.2 签约回跳接口
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
(2)请求报文模块说明:
该接口请求通过URL参数传递信息,无明确模块划分,URL参数包含返回码、错误信息、申请流水号、协议号、账号、完成时间、提交时间及签名等,其中返回码、申请流水号、账号、完成时间、提交时间、签名为必填参数,错误信息、协议号为选填参数,这些参数共同传递签约后的相关结果数据。
(3)响应报文模块说明:
无特定模块划分,商户系统仅需返回“SUCCESS”或“ERROR”字符串,告知通联支付签约回跳信息是否已成功接收,无需返回复杂结构化数据。
3.10.2.1 接口功能
通联签约请求流程结束后,会自动回跳到商户在签约申请时上送的回跳地址(BACKURL),默认采用 HTTP POST 方式回跳。
支持灵活设置回跳方式,若需采用 GET 方式,可在 BACKURL 的值前加上 “GET:”;若希望通过 GET 方式不携带通联参数跳转,可在 BACKURL 前面加上 “GNP:”。
回跳时会携带返回码、申请流水号等关键参数,其中当返回码为 “2000” 时,表示签约结果未明确,接入方需设置超时时间并等待系统通知,且一键绑卡签约回调返回码均为 “2000”。
3.10.2.2 请求报文
|
URL参数名 |
说明 |
类型 |
取值 |
限制 |
备注 |
|
RETCODE |
返回码 |
C(4) |
|
M |
当返回码为“2000”时,表示该签约结果未明确,接入方需要设置超时时间然后等待系统通知。 一键绑卡签约回调返回码都是“2000”。 |
|
RETMSG |
错误信息 |
|
|
C |
|
|
REQ_SN |
申请流水号 |
C(40) |
原申请报文中的交易流水REQ_SN |
M |
|
|
AGRMNO |
协议号 |
C(1,100) |
协议号 |
C |
成功时有值 |
|
ACCOUNT_NO |
账号 |
N(1,32) |
账号 |
M |
|
|
FINTIME |
完成时间 |
C(14) |
yyyyMMddHHmmss |
M |
|
|
SUBMITTIME |
提交时间 |
C(14) |
yyyyMMddHHmmss |
M |
|
|
SIGN |
签名 |
|
使用SHA1withRSA签名。签名原始内容为返回码|协议号|账号|申请流水号|提交时间 |
M |
|
|
|
|
|
|
|
|
3.10.2.3 例子
RETCODE=2000&RETMSG=%E5%B7%B2%E5%8F%91%E9%80%81%E9%93%B6%E8%A1%8C&REQ_SN=200604000005432-0001642491041190&AGRMNO=&ACCOUNT_NO=**&FINTIME=&SUBMITTIME=20220118153044&SIGN=4aa9683c944bd79c8d31ba4608a555048559e3cfa3631c7278cc7668b0259325962ab7b6c98216444b228881773901e380c6ab8a4a94d36549d81ce0997a12552d43d4b7f7f06bab1b1e7efdabeb9c4b57bc4d2d870be06550b8cc4c3fbc4b161f0c5d3d756f1e1e4151b1a202757aa8fb988ebdb28b2868432bbddc40de571a26500ab665a04b1b5b955457ee7070fb2ffb9ab78d3a53604d3382334fe9dcbaa2461b52efff64b230d6f577db21aff63ab30493484c8d8ab9e4125055c2518b98403da26ddc95689748bc47b9c40cc2c285f68ab53a6b0c90978d40251bc9cd78c5f0bb9e7d53b2f5566038dc98dfbaf13ac2183f21091c4fd5f007d1ed0264
3.10.3 签约结果通知(310006)
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
(2)请求报文模块说明:
该接口请求由通联通过HTTP GET方式向商户指定URL发起,通过URL参数传递信息,无模块划分,参数包括交易类型(TRXCODE)、返回码(RETCODE)、错误信息(RETMSG)、申请流水号(REQ_SN)、协议号(AGRMNO)、账号(ACCOUNT_NO)、完成时间(FINTIME)、手机号(TEL)、提交时间(SUBMITTIME)及签名(SIGN),其中交易类型、返回码、申请流水号、完成时间、提交时间、签名为必填参数,错误信息、协议号、账号、手机号为选填参数,账号默认返回后4位,手机号需申请配置才返回。
(3)响应报文模块说明:
无模块划分,商户系统仅需返回“SUCCESS”或“ERROR”字符串,用于告知通联支付签约结果通知是否已成功接收,无需额外返回其他数据。
3.10.3.1 接口功能
由通联主动向商户指定的通知地址(NOTIFYURL)发起请求,传递签约结果相关信息,包括交易类型、返回码、申请流水号、协议号等,让商户及时获取签约的最终结果。
支持根据配置决定是否返回全卡号,默认情况下仅返回卡号后 4 位,若商户有特殊需求,可申请配置返回全卡号,同时手机号也需申请配置才会在通知中返回。
通知中的签名采用 SHA1withRSA 算法,签名原始内容为返回码 | 协议号 | 账号 | 申请流水号 | 提交时间,商户可通过验证签名确保通知信息的真实性和完整性,防止信息被篡改。
3.10.3.2 请求报文
|
URL参数名 |
说明 |
类型 |
取值 |
限制 |
备注 |
|
TRXCODE |
交易类型 |
C(6) |
310006 |
M |
|
|
RETCODE |
返回码 |
C(4) |
|
M |
|
|
RETMSG |
错误信息 |
|
|
C |
|
|
REQ_SN |
申请流水号 |
C(40) |
原申请报文中的交易流水REQ_SN |
M |
|
|
AGRMNO |
协议号 |
C(1,100) |
协议号 |
C |
成功时有值 |
|
ACCOUNT_NO |
账号 |
N(1,32) |
账号 |
C |
根据配置是否返回全卡号,默认卡号后4位; |
|
FINTIME |
完成时间 |
C(14) |
yyyyMMddHHmmss |
M |
|
|
TEL |
手机号 |
C(13) |
|
C |
需要申请配置才返回 |
|
SUBMITTIME |
提交时间 |
C(14) |
yyyyMMddHHmmss |
M |
|
|
SIGN |
签名 |
|
使用SHA1withRSA签名。签名原始内容为返回码|协议号|账号|申请流水号|提交时间 |
M |
|
3.10.3.3 响应报文
商户系统返回一行内容
SUCCESS或者ERROR
3.10.3.4 例子
http://baidu?ACCOUNT_NO=****&RETCODE=0000&RETMSG=交易成功&REQ_SN=200604000005432-0001642487547440&TRXCODE=310004&AGRMNO=AIP4545220118001006311&FINTIME=20220118143344&SUBMITTIME=20220118143230&SIGN=5cfe8b32c95840234653a35565b87083614188b9e2117b7be5f8e311327d636a0e4c99e99c69cc316cddac48ff9d6d4e4b750ac74c6c4654353995e42c33dbbe94d4d20922566fc869ae20c7a13827636a7069a90caa3b1c70a9886af17a817fcdb73b948f22a345858112f1ebb703e85715695f76d55d7cd1a8e33a784b35cfaea1999c90c14b12880d53bf978ab10b1aba086e8648694c04c09642d2a251c2b6cf36f0b756b0225a06c13a9424d5ffe0d74693eb7145d37ee34d7c9f6a56421d1683ec9427fd6b0ec2a904bb5ad31b4ff3378627e0
3.10.4 短信签约(310009)
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
(2)请求报文模块说明:
- INFO模块:包含交易代码、版本、数据格式、处理级别、商户代码、用户名、交易批次号及签名信息等交易基础信息,为必填模块,是接口请求的基础支撑,确保交易参数的准确性。
- PROTOCOLREQ模块:涵盖商户代码、申请时间、签约模式、账号类型、银行代码、账号名、开户证件类型、证件号、手机号、账号属性、回跳地址等签约核心信息,为必填模块,提供短信签约所需的各项业务参数,保障签约流程的顺利发起。
(3)响应报文模块说明:
- INFO模块:返回交易代码、版本、数据格式、交易批次号、返回代码、错误信息及签名信息等,反馈短信签约请求的整体处理情况,是判断请求是否成功的关键依据。
- PROTOCOLREQ模块:返回返回码、错误文本及签约模式等,明确短信签约申请的具体处理结果,让商户了解签约申请是否被正常受理。
3.10.4.1 接口功能
作为网关签约的扩充功能,主要针对商户系统不能打开外部链接的场景,通过向持卡人发送短信,持卡人点击短信中的链接即可进入签约页面完成签约操作,拓宽了签约的适用场景
支持多种签约模式,包括 0(快捷签约)、1(一键绑卡)、2(商委网关)、3(快捷网关),商户可根据实际业务需求选择合适的签约模式发起短信签约请求。
需商户提供持卡人的手机号,以便通联向其发送包含签约链接的短信,同时商户需指定回跳地址(BACKURL),持卡人完成签约后会回跳到该地址,方便后续业务流程的衔接。
接口请求和响应均包含签名信息,采用特定的签名算法保障数据在传输过程中的安全性,防止数据被非法篡改,确保短信签约流程的安全可靠。
3.10..4.2 请求报文
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310009 |
M |
|
|
VERSION |
版本 |
C(2) |
04 |
M |
|
|
|
DATA_TYPE |
数据格式 |
N(1) |
2:xml格式 |
M |
|
|
|
LEVEL |
处理级别 |
N(1) |
0-9 0优先级最低,默认为5 |
M |
|
|
|
MERCHANT_ID |
商户代码 |
C(15) |
商户ID |
M |
|
|
|
USER_NAME |
用户名 |
C(1,20) |
|
M |
|
|
|
USER_PASS |
用户密码 |
|
|
C |
|
|
|
REQ_SN |
交易批次号 |
C(40) |
|
M |
不重复流水 |
|
|
SIGNED_MSG |
签名信息 |
C |
|
M |
|
|
|
PROTOCOLREQ |
MERCHANT_ID |
商户代码 |
C(15) |
商户号ID |
M |
|
|
SUBMIT_TIME |
申请时间 |
C (14) |
YYYYMMDDHHMMSS |
M |
|
|
|
SIGN_MODE |
签约模式 |
C(1) |
0快捷签约 1一键绑卡 2-商委网关 3-快捷网关 |
M |
|
|
|
BUSINESS_CODE |
业务代码 |
C(6) |
|
C |
|
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00借记卡,02信用卡。不填默认为借记卡00。 |
M |
|
|
|
BANK_CODE |
银行代码 |
C(12) |
银行代码,见附录3.3 |
M |
|
|
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
借记卡或信用卡上的所有人姓名。 |
M |
|
|
|
ID_TYPE |
开户证件类型 |
C (1) |
参考3.1 |
M |
|
|
|
ID |
证件号 |
C (1,22) |
|
M |
|
|
|
TEL |
手机号 |
C (11) |
|
M |
|
|
|
ACCOUNT_PROP |
账号属性 |
C (1) |
0私人,1公司。不填时,默认为私人0。 |
M |
|
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
|
|
|
MERREM |
商户保留信息 |
C (0,128) |
商户保留信息 |
C |
|
|
|
REMARK |
备注 |
C (1,50) |
供商户填入参考信息 |
C |
|
|
|
BACKURL |
跳转地址 |
C (0,256) |
|
M |
|
|
|
NOTIFYURL
|
通知地址 |
C (0,256) |
|
C |
|
3.10.4.3 响应报文
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310009 |
M |
|
|
VERSION |
版本 |
C(2) |
03 |
M |
|
|
|
DATA_TYPE |
数据格式 |
N(1) |
2:xml格式 |
M |
|
|
|
REQ_SN |
交易批次号 |
C(40) |
|
M |
|
|
|
RET_CODE |
C(4) |
参考3.4 |
M |
|
||
|
ERR_MSG |
错误信息 |
C(1,256) |
|
C |
|
|
|
SIGNED_MSG |
签名信息 |
C |
|
M |
|
|
|
PROTOCOLRSP |
RET_CODE |
返回码 |
C(4) |
参考3.4 |
C |
|
|
ERR_MSG |
错误文本 |
C(1,256) |
|
C |
|
|
|
SIGN_MODE |
签约模式 |
C(1) |
|
|
|
|
|
数字签名原文为没有SIGNED_MSG 签名信息项的xml全文。 |
||||||