目录
3.1收付通协议支付接口组
接口调用关系

挂网协议展示要求
商户对接通联快捷签约接口,需把附录F.关于快捷、代收服务协议资料相关协议挂网展示。
3.1.1协议支付签约短信触发(310001)
字段与报文模块说明:
(1)字段类型和限制类型定义
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
(2)请求报文模块说明
请求报文包含 INFO、FAGRA 和 RISKINFO 三个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号等),为必填模块。
FAGRA 模块:协议签约短信触发核心业务元素,用于传递签约相关核心信息,为必填模块。
RISKINFO 模块:风险控制相关元素,用于传递设备、IP 等风险防控信息,为选填模块。
(3)响应报文模块说明
响应报文包含 INFO、FAGRARET 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息等)。
FAGRARET:响应的业务返回元素,返回短信触发业务的具体处理结果。
3.1.1.1 接口功能
- 商户端可按业界 60 秒标准设置重新触发短信的间隔时间。
- 仅当请求头部与明细返回码均为 “0000” 时,向持卡人发送验证码。
- 测试环境默认短信验证码为 “111111”。
3.1.1.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310001 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRA |
MERCHANT_ID |
商户代码 |
C(10,20) |
商户ID |
M |
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00银行卡,02信用卡。不填默认为银行卡00。 06:银联token账号 |
C |
|
|
|
BANK_CODE |
银行代码 |
C(8) |
银行代码,存折必须填写。参见附录A.3银行代码 |
C |
存折必填,银行卡视情况填写, 详情见2.9.4银行代码说明 针对账户类型传06的,必须上送银行代码 |
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
M |
||
|
CREDIT_ACCTNO |
信用卡卡号 |
N(1,32) |
工行、建行走信还特色渠道签约除了上送借记卡还需上送信用卡,具体咨询业务 |
C |
如是一般的协议支付签约可忽略该字段 |
|
|
CREDIT_BANKCODE |
信用卡银行代码 |
N(1,32) |
工行、建行走信还特色渠道签约除了上送借记卡还需上送信用卡,具体咨询业务 |
C |
如是一般的协议支付签约可忽略该字段,针对账户类型传06的,必须上送银行代码 |
|
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
银行卡或存折上的所有人姓名 |
M |
||
|
ACCOUNT_PROP |
账号属性 |
C (1) |
0私人,1公司。不填时,默认为私人0。 |
M |
|
|
|
ID_TYPE |
开户证件类型 |
C (1) |
参考A.1证件类型 |
M |
||
|
ID |
证件号 |
C (1,22) |
|
M |
||
|
TEL |
手机号/小灵通 |
C (1,13) |
|
M |
||
|
CVV2 |
CVV2 |
C (3) |
C |
无需填写 |
||
|
VALIDDATE |
有效期 |
C (4) |
C |
无需填写 |
||
|
CU_PROTOVN |
银联协议版本号 |
C(32) |
C |
|||
|
BNK_PROTOVN |
银行协议版本号 |
C(32) |
C |
|||
|
MC_PROTOVN |
商户协议版本 |
C(31) |
C |
|||
|
MERREM |
商户保留信息 |
C (1,128) |
|
C |
供商户填入参考信息。若为信用卡,填有效期, 开发人员可省略该字段,也可以当作备注字段使用 |
|
|
EXPIRED |
协议失效日 |
C (8) |
yyyyMMdd |
C |
与单笔最大限额、扣款时间单位、单位时间内扣款次数要素组合上送,要么全送,要么全不上送,如不上送,会根据系统配置的默认值,具体咨询业务。 |
|
|
SINGLEMAXAMT |
单笔最大限额 |
C (1,12) |
整数,单位分 |
C |
与协议失效日、扣款时间单位、单位时间内扣款次数要素组合上送,要么全送,要么全不上送,如不上送,会根据系统配置的默认值,具体咨询业务人员。 |
|
|
PERIOD_UNIT |
扣款时间单位 |
C (2) |
00-年 01-半年 02-季度 04-月 06-周 07-日
|
C |
与协议失效日、单笔最大限额、单位时间内扣款次数要素组合上送,要么全送,要么全不上送,如不上送,会根据系统配置的默认值,具体咨询业务人员。 |
|
|
MAX_CNT_LIMIT |
单位时间内扣款次数 |
C (2) |
|
C |
与协议失效日、单笔最大限额、扣款时间单位要素组合上送,要么全送,要么全不上送,如不上送,会根据系统配置的默认值,具体咨询业务人员。 |
|
|
REMARK |
备注 |
C (1,128) |
|
C |
供商户填入备注信息。 |
|
|
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.1.1.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310001 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B12与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRARET |
RET_CODE |
返回码 |
C(4) |
参考附录B12与B6 |
C |
|
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|
3.1.1.4 例子
3.1.2 协议支付签约(310002)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、FAGRC 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
FAGRC 模块:协议签约核心业务元素,用于传递签约验证相关信息(如原请求流水、验证码等),为必填模块。
响应报文包含 INFO、FAGRCRET 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
FAGRCRET:响应的业务返回元素,返回签约业务具体结果(如协议号、明细返回码等)。
3.1.2.1 接口功能
- 短信验证码有效期为 2 - 10 分钟。
- 未获取签约结果时,可跳过短信触发步骤重新发起签约,但请求流水号(REQ_SN)需保持唯一,不可重复。
- 同一商户、同一持卡人且验证信息(如账号、证件号)正确时,接口返回的协议号始终一致,且返回码均为 “0000”。
3.1.2.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310002 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRC |
MERCHANT_ID |
商户代码 |
C(10,20) |
商户ID |
M |
|
|
SRCREQSN |
原请求流水 |
C(60) |
对应申请 请求报文中的REQ_SN |
M |
||
|
VERCODE |
验证码 |
C(6) |
短信验证码 |
M |
|
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
||
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
银行卡或存折上的所有人姓名 |
C |
||
|
ID |
证件号 |
C (1,22) |
|
C |
||
|
TEL |
手机号/小灵通 |
C (1,13) |
|
C |
3.1.2.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310002 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B13与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRCRET |
AGRMNO |
协议号 |
C(22) |
C |
成功时协议号不为空 |
|
|
RET_CODE |
返回码 |
C(4) |
参考附录B13与B6 |
C |
|
|
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|
3.1.2.4 例子
3.1.3协议支付解约(310003)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、FAGRCNL 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
FAGRCNL 模块:协议解约核心业务元素,用于传递解约定位信息(如协议号、账号等),为必填模块。
响应报文包含 INFO、FAGRCNLRET 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
FAGRCNLRET:响应的业务返回元素,返回解约业务具体处理结果(如明细返回码、错误文本等)。
3.1.3.1 接口功能
用于商户为持卡人解除已签约的协议支付协议,支持通过 “协议号” 或 “账号” 定位待解约协议(上送协议号时优先按协议号查询,仅上送账号时按 “商户号 + 账号” 维度查询)。
直接返回解约成功 / 失败结果及失败原因。
3.1.3.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310003 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRCNL |
MERCHANT_ID |
商户代码 |
C(15) |
商户ID |
M |
|
|
ACCOUNT_NO |
账号 |
C(32) |
借记卡或信用卡 |
C |
账号和协议号其中一个必填 |
|
|
AGRMNO |
协议号 |
C(22) |
签约时返回的协议号 |
M |
协议号规则为:AIP+卡号后四位+YYMMDD+9位流水 (上送了协议号优先按协议号查,只有卡号,按商户号加卡号纬度查) |
3.1.3.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310003 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B14与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRCNLRET |
RET_CODE |
返回码 |
C(4) |
参考附录B14与B6 |
C |
|
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|
3.1.3.4 例子
3.1.4协议支付(310011)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、FASTTRX 模块,可选包含 LEDGERS/LEDGERDTL、RISKINFO 模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
FASTTRX 模块:协议支付核心业务元素,用于传递支付相关信息(如协议号、金额、账号名等),为必填模块。
LEDGERS/LEDGERDTL 模块:分账相关元素,用于传递分账信息(如分账商户号、分账金额等),为选填模块(无分账需求可省略)。
RISKINFO 模块:风险控制相关元素,用于传递风险防控信息(如设备型号、客户端 IP 等),为选填模块。
响应报文包含 INFO、FASTTRXRET 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
FASTTRXRET:响应的业务返回元素,返回支付业务具体结果(如银行流水号、卡号后 4 位、完成日期等)。
3.1.4.1 接口功能
- 基于已签约协议号向持卡人发起实时扣款请求,返回支付结果。
- 若持卡人在银行端变更手机号、或在网银取消快捷协议导致协议无效,接口返回 “3043(未与银行签约)” 错误码,需引导持卡人重新签约。
- 支持分账功能,无分账需求可省略分账相关模块。
3.1.4.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310011 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
06 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FASTTRX |
BUSINESS_CODE |
业务代码 |
C(6) |
见附录A2业务代码 |
M |
|
|
MERCHANT_ID |
商户号 |
C(15) |
M |
|||
|
SUBMIT_TIME |
提交时间 |
C(14) |
YYYYMMDDHHMMSS |
M |
||
|
AGRMNO |
协议号 |
C(22) |
签约时返回的协议号 |
C |
卡号和协议号其中一个必填,优先通过卡号匹配协议号 |
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00银行卡,02信用卡。不填默认为银行卡00。 06:银联token账号 |
C |
|
|
|
BANK_CODE |
银行代码 |
C(8) |
银行代码,存折必须填写。参见附录A.3银行代码 |
C |
存折必填,银行卡视情况填写,详情见2.9.4银行代码说明 针对账户类型传06的,必须上送银行代码 |
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
||
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
银行卡或存折上的所有人姓名 |
M |
||
|
AMOUNT |
金额 |
C(12) |
整数,单位分 |
M |
||
|
CURRENCY |
货币类型 |
C (3) |
人民币:CNY, 港元:HKD,美元:USD。不填时,默认为人民币。 |
C |
|
|
|
ID_TYPE |
开户证件类型 |
C (1) |
参考A.1证件类型 |
C |
||
|
ID |
证件号 |
C (1,22) |
|
C |
||
|
TEL |
手机号/小灵通 |
C (1,13) |
|
C |
||
|
CVV2 |
CVV2 |
C (3) |
信用卡时必填 |
C |
无需填写 |
|
|
VALIDDATE |
有效期 |
C (4) |
信用卡时必填,格式MMYY(信用卡上的两位月两位年) |
C |
无需填写 |
|
|
CUST_USERID |
自定义用户号 |
C (1,128) |
|
C |
商户自定义的用户号,开发人员可当作备注字段使用 |
|
|
FEEFLAG |
持卡人手续费 |
C(1) |
C |
0:持卡人承担手续费 1:商户承担手续费 |
||
|
SETTACCT |
本交易结算户 |
C(32) |
不同交易想要结算到不同账户,可上送。不需分别结算时不需填写。 |
C |
||
|
REMARK |
备注 |
C (1,50) |
|
C |
供商户填入备注信息。 |
|
|
SUMMARY |
交易附言 |
C(1,140) |
填入网银的交易备注,可以在网银明细中查询到该字段信息,但部分银行可能不支持 |
C |
||
|
NOTIFYURL |
通知地址 |
C (200) |
|
C |
交易无论成功还是失败都会通知到上送的地址,通知格式参考3.8.3快捷单笔交易结果通知 |
|
|
LEDGERS/ LEDGERDTL |
SN |
记录序号 |
C(1,4) |
分账记录序号 |
C |
无分账需求,无需改节点 |
|
MERCHANT_ID |
分账商户号 |
C(10,20) |
商户ID |
C |
||
|
AMOUNT |
分账金额 |
C(12) |
整数,单位分TYPE为0时必填 |
C |
||
|
TYPE |
分账类型 |
C(1) |
0按金额分账 1按比例分账 默认0(如果按照比例分的话是后台固定配置的,不需要上送,分账金额可以为空,如需配置,请联系通联客户经理提需求配置) |
C |
||
|
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.1.4.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310011 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
06 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B1与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FASTTRXRET |
RET_CODE |
返回码 |
C(4) |
参考附录B1与B6 |
C |
|
|
SETTLE_DAY |
完成日期 |
C(8) |
YYYYMMDD |
C |
上送08版本,完成时间返回14位格式:YYYYMMDDhhmmss |
|
|
ACCT_SUFFIX |
卡号后4位 |
C(4) |
C |
|
||
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|
||
|
VOUCHERNO |
银行流水号 |
C(1,46) |
C |
VERSION为大于等于06才返回该值 |
3.1.4.4 例子
无分账需要不需要上传分账节点 <LEDGERS> </LEDGERS>
3.1.5批量协议支付(310016)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、BODY 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
BODY 模块:批量支付核心容器模块,包含 TRANS_SUM 子模块和 TRANS_DETAILS/FASTTRX_DETAIL 子模块,为必填模块;其中:
TRANS_SUM 子模块:批量汇总元素,用于传递批次总记录数、总金额等汇总信息;
TRANS_DETAILS/FASTTRX_DETAIL 子模块:批量明细元素,用于传递每笔支付的核心业务信息(如账号、金额、账号名等)。
响应报文包含 INFO、BODY 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
BODY 模块:批量响应核心容器模块,通过 RET_DETAILS/RET_DETAIL 子模块返回每笔明细的处理结果(如原明细序号、明细返回码、错误信息等)。
3.1.5.1 接口功能
- 用于批量发起协议支付扣款,单次批次建议≤2000 笔,且批次内无重复卡号。(不能有一个批次只有一笔交易明细情况)。
- 接口返回 “受理成功” 仅代表接收请求,非最终支付结果,需通过查询接口确认交易状态。
3.1.5.2 请求报文
|
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310016 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
BODY/ TRANS_SUM |
BUSINESS_CODE |
业务代码 |
C(6) |
见附录A2业务代码 |
M |
|
|
MERCHANT_ID |
商户号 |
C(15) |
M |
|||
|
SETTDAY |
清算日期 |
C(14) |
仅供特殊商户使用,普通商户不用理会该字段 |
C |
||
|
SUBMIT_TIME |
提交时间 |
C(14) |
YYYYMMDDHHMMSS |
M |
||
|
TOTAL_ITEM |
总记录数 |
C(1,4) |
M |
|||
|
TOTAL_SUM |
总金额 |
C(1,12) |
M |
|||
|
BODY/ TRANS_SUM/ LEDGERS/ LEDGERDTL |
SN |
分账序号 |
C(1,4) |
分账记录序号 |
C |
无需分账不需要该节点,按批次汇总分账,汇总与明细分账只能二选一 |
|
MERCHANT_ID |
分账商户号 |
C(10,20) |
商户id |
C |
||
|
AMOUNT |
分账金额 |
C(1,12) |
整数,单位分TYPE为0时必填(分给该商户多少钱) |
M |
||
|
TYPE |
分账类型 |
C(1) |
只支持按比例分账,上送值为1,联系客户经理配置 |
C |
||
|
BODY/ TRANS_SUM/ DETAIL_LEDGERS/LEDGERDTL |
SN |
分账序号 |
C(1,4) |
C |
按批次对的具体明细sn分账,汇总与明细分账只能二选一 |
|
|
MERCHANT_ID |
分账商户号 |
C(10,15) |
分账的商户号需要先在后台配置 |
C |
||
|
AMOUNT |
分账金额 |
N(1,12) |
分账类型为:0 按金额分账时需填写 |
C |
||
|
TYPE |
分账类型 |
C(1) |
0按金额分账; 1 按比例分账,默认0(如果按比例分是后台固定配置的,分账金额可为空) |
C |
||
|
DETAIL_SN |
分账明细对应的sn |
C(1,4) |
需分账的记录序号 |
C |
||
|
BODY/ TRANS_DETAILS/ FASTTRX_DETAIL |
SN |
记录序号 |
C(1,4) |
同一个请求内必须唯一。建议从0001开始递增,交易结果查询时,该字段会原样返回 |
M |
|
|
AGRMNO |
协议号 |
C(22) |
签约时返回的协议号 |
C |
卡号和协议号其中一个必填,优先通过卡号匹配协议号 |
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00银行卡,02信用卡。不填默认为银行卡00。 06:银联token账号 |
C |
|
|
|
BANK_CODE |
银行代码 |
C(8) |
银行代码,存折必须填写。参见附录A.3银行代码 |
C |
存折必填,银行卡视情况填写,详情见2.9.4银行代码说明 针对账户类型传06的,必须上送银行代码 |
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
卡号和协议号其中一个必填,优先通过卡号匹配协议号 |
|
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
银行卡或存折上的所有人姓名 |
M |
||
|
CURRENCY |
货币类型 |
C (3) |
人民币:CNY, 港元:HKD,美元:USD。不填时,默认为人民币。 |
C |
|
|
|
ID_TYPE |
开户证件类型 |
C (1) |
参考A.1证件类型 |
C |
||
|
ID |
证件号 |
C (1,22) |
|
C |
||
|
TEL |
手机号/小灵通 |
C (1,13) |
|
C |
||
|
CVV2 |
CVV2 |
C (3) |
C |
无需填写 |
||
|
VAILDDATE |
有效期 |
C (4) |
C |
无需填写 |
||
|
AMOUNT |
金额 |
C(1,12) |
整数,单位分) |
M |
||
|
E_USER_CODE |
用户编号 |
C (1,20) |
|
C |
客户编号,开发人员可当作备注字段使用 |
|
|
CUST_USERID |
自定义用户号 |
C (1,128) |
|
C |
商户自定义的用户号,开发人员可省略该字段,也可以当作备注字段使用,该字段会在对账文件中原样返回 |
|
|
SUMMARY |
交易附言 |
C (1,140) |
|
C |
填入网银的交易备注,可以在网银明细中查询到该字段信息,但部分银行可能不支持 |
|
|
REMARK |
备注 |
C (1,50) |
|
C |
供商户填入备注信息。 |
|
|
SETTACCT |
本交易结算户 |
C(32) |
结算到商户的账户,不需分别清算时不需填写。 |
C |
3.1.5.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310016 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B2与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
BODY/ RET_DETAILS RET_DETAIL 注意:如果整批请求被通联拒绝,则返回报文中无此字节信息 |
SN |
记录序号 |
C(4) |
原 请求报文中的SN字段值,原封不动的返回 |
C |
|
|
RET_CODE |
返回码 |
C(4) |
参考附录B2与B6 |
C |
||
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|
3.1.5.4 例子
3.1.6签约结果查询(340009)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、QAGRINFO 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
QAGRINFO 模块:签约结果查询核心业务元素,用于传递查询条件(如查询流水号、协议类型、查询模式等),为必填模块。
响应报文包含 INFO、QAGRRSP 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
QAGRRSP 模块:响应的业务返回元素,通过 QAGRDETAIL 子模块返回签约结果详情(如协议号、银行代码、协议状态等)。
3.1.6.1 接口功能
- 用于查询 “协议支付签约短信触发(310001)” 或 “H5 链接签约(310006)” 的签约结果。
- 仅支持查询近 2 天内的签约请求数据。
3.1.6.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
340009 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
USER_PASS |
用户密码 |
C(1,20) |
C |
不校验,(无需填写或可置空) |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
QAGRINFO |
MERCHANT_ID |
商户代码 |
C(15) |
商户ID |
M |
|
|
AGRTYPE |
协议类型 |
C(2) |
01:标准快捷协议 |
M |
||
|
QUERY_MODE |
查询模式 |
C(1) |
1:通过签约流水号查询 |
M |
|
|
|
QUERY_SN |
要查询的交易流水 |
C(60) |
也就是原请求交易中的REQ_SN的值 |
M |
3.1.6.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
340009 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B1与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
QAGRRSP/ QAGRDETAIL |
MERCHANT_ID |
商户代码 |
C(10,20) |
C |
商户ID |
|
|
AGRMNO |
协议号 |
C(100) |
C |
|
||
|
BANK_CODE |
银行代码 |
C(3,8) |
银行代码,见附录A3 |
C |
存折必填,银行卡视情况填写,详情见2.9.4银行代码说明 |
|
|
ACCOUNT_NO |
账号 |
C(4) |
卡号 |
C |
根据配置是否返回全卡号,默认卡号后4位; |
|
|
TEL |
手机号 |
C (1,13) |
C |
根据配置是否返回 |
||
|
STATUS |
协议状态 |
C(4) |
C |
0:申请成功待确认 1:处理中 2 签约成功 3签约失败 4签约申请失败
|
||
|
ERR_MSG |
错误文本 |
C(256) |
C |
|
3.1.6.4 例子
3.1.7协议支付签约合并支付(310010)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、FASTTRX 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
FASTTRX 模块:签约合并支付核心业务元素,用于传递签约验证(如原请求流水、验证码)和支付(如金额、协议号)相关信息,为必填模块。
响应报文包含 INFO、FASTTRXRETC 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
FASTTRXRETC:响应的业务返回元素,同时返回签约结果(如协议号)和支付结果(如明细返回码、卡号后 4 位等)。
3.1.7.1 接口功能
- 支持 “首次签约 + 实时支付” 一站式完成,也兼容非首次扣款(仅需传入协议号)。
- 验证码有效期 10 分钟;超时后需先通过 “签约结果查询(340009)” 查协议号,再通过 “交易结果查询(200004)” 查支付结果。查询结果有如下四种情况:1)签约交易不存在,支付交易不存在:说明交易没上送到通联服务端,商户可重发交易。 2)签约成功,支付成功:340009查询接口返回协议号,200004查询接口返回成功的返回码。 3)签约成功,支付失败:340009查询接口返回协议号,200004查询接口返回失败的返回码。 4)签约失败:340009查询返回1002找不到协议记录。
3.1.7.2 请求报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310010 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
LEVEL |
处理级别 |
N(1) |
5 |
M |
||
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
USER_NAME |
用户名 |
C(1,20) |
M |
|||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FASTTRX |
BUSINESS_CODE |
业务代码 |
C(6) |
见附录A2业务代码 |
M |
|
|
MERCHANT_ID |
商户号 |
C(10,20) |
M |
|||
|
SUBMIT_TIME |
提交时间 |
C(14) |
YYYYMMDDHHMMSS |
M |
||
|
SRC_REQ_SN |
原请求流水 |
C(40) |
对应申请 请求报文中的REQ_SN |
M |
||
|
VER_CODE |
验证码 |
C(6) |
短信验证码 |
M |
||
|
AGRMNO |
协议号 |
C(22) |
C |
当该字段有值时,按非首次扣款的流程走。此时SRCREQSN、VERCODE可填空 |
||
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00银行卡,02信用卡。不填默认为银行卡00。 06:银联token账号 |
C |
||
|
BANK_CODE |
银行代码 |
C(8) |
银行代码,存折必须填写。参见附录A.3银行代码 |
C |
存折必填,银行卡视情况填写,详情见2.9.4银行代码说明 针对账户类型传06的,必须上送银行代码 |
|
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
||
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
银行卡或存折上的所有人姓名 |
M |
||
|
AMOUNT |
金额 |
C(12) |
整数,单位分 |
M |
||
|
CURRENCY |
货币类型 |
C (3) |
人民币:CNY, 港元:HKD,美元:USD。不填时,默认为人民币。 |
C |
||
|
ID_TYPE |
开户证件类型 |
C (1) |
参考A.1证件类型 |
C |
||
|
ID |
证件号 |
C (1,22) |
C |
|||
|
TEL |
手机号/小灵通 |
C (1,13) |
C |
|||
|
CVV2 |
CVV2 |
C (3) |
C |
|||
|
VAILDDATE |
有效期 |
C (4) |
C |
|||
|
CUST_USERID |
自定义用户号 |
C (1,128) |
C |
商户自定义的用户号,开发人员可当作备注字段使用 |
||
|
SUMMARY |
交易附言 |
C (30) |
C |
填入网银的交易备注, 开发人员可省略该字段,也可以当作备注字段使用 |
||
|
REMARK |
备注 |
C (1,50) |
C |
供商户填入备注信息。 |
3.1.7.3 响应报文
|
接口 |
字段ID |
字段解释 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1,20) |
310010 |
M |
详见报文头说明 |
|
VERSION |
版本号 |
C(2) |
05 |
M |
||
|
DATA_TYPE |
数据格式 |
C(1) |
2 |
M |
||
|
REQ_SN |
请求流水号 |
C(0,60) |
M |
|||
|
RET_CODE |
返回代码 |
C(4) |
参考附录B1与B6 |
M |
||
|
ERR_MSG |
错误信息 |
C(1,256) |
M |
|||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FASTTRXRETC |
AGRMNO |
协议号 |
C(22) |
C |
||
|
ACCT_SUFFIX |
卡号后4位 |
C(4) |
C |
|
||
|
SETTLE_DAY |
完成日期 |
C(8) |
YYYYMMDD |
C |
|
|
|
RET_CODE |
返回码 |
C(4) |
参考附录B1与B6 |
C |
|
|
|
ERR_MSG |
错误文本 |
C(256) |
C |
|
- RET_CODE非0000,AGRMNO无值,代表签约失败,不再做进一步的支付,返回码代表签约失败的原因。
- RET_CODE非0000,AGRMNO有值,代表签约成功,支付失败,返回码代表支付失败的原因。
- RET_CODE等于0000,AGRMNO有值,代表签约成功,支付成功。
3.1.7.4 例子
3.1.8 快捷签约协议展示申请(310008)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、BANKDOCREQ 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
BANKDOCREQ 模块:协议展示申请核心业务元素,用于传递定位协议所需信息(如银行代码、账号、协议类型等),为必填模块。
响应报文包含 INFO、BANKDOCRSP 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
BANKDOCRSP 模块:响应的业务返回元素,通过 BANKDOCS/BANKDOC 子模块返回协议详情(如协议文件名、展示链接、协议类型等)。
3.1.8.1接口功能
- 申请协议展示链接,返回包含《通联支付快捷支付服务协议》在内的地址列表。
- 支持通过 “银行代码” 或 “账号” 定位协议类型(如快捷、银联 token 协议)。
3.1.8.2请求报文说明
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310008 |
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 |
|||
|
REQ_SN |
交易批次号 |
C(40) |
M |
商户号+商户自定义不重复流水号 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
BANKDOCREQ |
BANK_CODE |
银行代码 |
C(8) |
银行代码,见附录3.3 账户类型传06的,必须上送银行代码 |
C |
银行代码与账号不能同时为空,且优先使用上送的银行代码。 |
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
C |
银行代码与账号不能同时为空,且优先使用上送的银行代码。 |
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00借记卡,02信用卡 |
M |
||
|
AGRTYPE |
协议类型 |
C(4) |
00 商委,01快捷,04 银联token协议
|
M |
3.1.8.3响应报文说明
返回的地址列表会默认包含《通联支付快捷支付服务协议》。
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310008 |
M |
|
|
VERSION |
版本 |
C(2) |
06 |
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 |
|||
|
BANKDOCRSP |
BANK_CODE |
银行代码 |
C(8) |
银行代码,见附录3.3 |
M |
|
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00借记卡,02信用卡 |
C |
不区分时为空 |
|
|
BANKDOCRSP/ BANKDOCS/ BANKDOC |
NAME |
文件名 |
C(2,32) |
M |
||
|
URL |
URL |
C(1,128) |
M |
|||
|
AGRTYPE |
协议类型 |
C(4) |
AGRTYPE=04有该字段 |
C |
||
|
INSTCOD |
机构号 |
C(8) |
AGRTYPE=04有 银联值为00010000 |
C |
||
|
PROTOVN |
电子合同号 |
C(32) |
AGRTYPE=04有该字段 |
C |
||
|
数字签名原文为没有SIGNED_MSG 签名信息项的xml全文。 |
||||||
1 AGRTYPE的返回值为04,INSTCOD的返回值为00010000,则返回的PROTOVN的值对应于CU_PROTOVN(银联协议版本号)。
2 AGRTYPE的返回值为04,INSTCOD的返回值不为00010000,则返回的PROTOVN的值对应于BNK_PROTOVN(银行协议版本号)。
3 AGRTYPE 不为 04 ,PROTOVN返回值对应的是 快捷协议电子合同号。
3.1.9协议号授权同步(310030)
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求报文包含 INFO、FAGRA 两个模块,每个模块承担对应功能:
INFO 模块:报文公共元素,用于标识请求基本属性(如交易代码、版本号、商户号等),为必填模块。
FAGRA 模块:授权同步核心业务元素,用于传递授权信息(如银联协议版本号、银行协议版本号、账号等),为必填模块。
响应报文包含 INFO、FAGRCRET 两个模块,每个模块承担对应功能:
INFO:响应公共元素,返回请求的整体处理状态(如返回码、错误信息、请求流水号等)。
FAGRCRET:响应的业务返回元素,返回授权同步结果(如协议号、明细返回码、错误文本等)。
3.1.9.1 接口功能
- 用于 “544 号文改造” 场景下的授权信息同步,需上传银联 / 银行协议版本号。
- 同步成功后返回对应的协议号,用于后续支付操作。
3.1.9.2 请求报文
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310030 |
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 |
|||
|
REQ_SN |
交易批次号 |
C(40) |
M |
不重复流水 |
||
|
SIGNED_MSG |
签名信息 |
C |
M |
|||
|
FAGRA |
MERCHANT_ID |
商户代码 |
C(15) |
商户号ID |
M |
|
|
SUBMIT_TIME |
申请时间 |
C (14) |
YYYYMMDDHHMMSS |
M |
||
|
BANK_CODE |
银行代码 |
C(12) |
银行代码,见附录3.3 |
M |
||
|
ACCOUNT_TYPE |
账号类型 |
C(2) |
00借记卡,02信用卡。不填默认为借记卡00。 |
M |
||
|
ACCOUNT_NO |
账号 |
N(1,32) |
借记卡或信用卡 |
M |
||
|
ACCOUNT_NAME |
账号名 |
C(1,60) |
借记卡或信用卡上的所有人姓名。 |
M |
||
|
ACCOUNT_PROP |
账号属性 |
C (1) |
0私人,1公司。不填时,默认为私人0。 |
M |
||
|
ID_TYPE |
开户证件类型 |
C (1) |
参考3.1 |
M |
||
|
ID |
证件号 |
C (1,22) |
M |
|||
|
TEL |
手机号 |
C (11) |
M |
|||
|
CVV2 |
CVV2 |
C (3) |
信用卡时必填 |
C |
||
|
VALIDDATE |
有效期 |
C (4) |
信用卡时必填,格式MMYY(信用卡上的两位月两位年) |
C |
||
|
CU_PROTOVN |
银联协议版本号 |
C(32) |
M |
|||
|
BNK_PROTOVN |
银行协议版本号 |
C(32) |
M |
|||
|
MERREM |
商户保留信息 |
C (0,128) |
商户保留信息 |
C |
||
|
REMARK |
备注 |
C (1,50) |
供商户填入参考信息 |
C |
3.1.9.3 响应报文说明
|
接口 |
字段ID |
字段名称 |
类型 |
取值 |
限制 |
备注 |
|
INFO |
TRX_CODE |
交易代码 |
C(1, 20) |
310030 |
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 |
|||
|
FAGRCRET |
RET_CODE |
返回码 |
C(4) |
参考3.4 |
C |
|
|
ERR_MSG |
错误文本 |
C(1,256) |
C |
|||
|
AGRMNO |
协议号 |
C(22) |
C |
|||
|
数字签名原文为没有SIGNED_MSG 签名信息项的xml全文。 |
||||||
3.1.10 H5链接签约
字段与报文模块说明:
C:字符串
C (x,y):最小长度 x、最大长度 y 的字符串
N (x):固定 x 位整数
N (x,y):最小长度 x、最大长度 y 的整数
限制类型:M - 必填,C - 选填
请求以 URL 参数形式传递,核心参数模块承担对应功能:
基础标识参数模块:包含商户号(cusid)、请求流水号(filename),用于标识请求身份,为必填模块。
地址参数模块:包含回跳地址(backurl)、通知地址(notifyurl),用于配置签约后跳转和结果通知路径,其中 notifyurl 为必填,backurl 为选填。
签名参数模块:包含签名方式(signalg)、签名值(signstr),用于验证请求合法性,为必填模块。
响应包含页面响应和结果通知响应两部分,各模块承担对应功能:
页面响应模块:直接返回 H5 签约页面,引导持卡人完成签约操作,无固定 XML 结构。
结果通知响应模块:通过 notifyurl 推送 XML 格式通知,包含 INFO、FAGRARET 两个模块;其中:
INFO 模块:通知公共元素,返回通知整体状态(如返回码、请求流水号等);
FAGRARET 模块:通知业务元素,返回签约结果(如协议号、明细返回码等)。
3.1.10.1 接口功能
3.8.1.2 请求报文
|
URL参数名 |
|
说明 |
类型 |
取值 |
可空 |
备注 |
|
cusid |
|
商户号 |
C(16) |
|
非空 |
|
|
filename |
|
请求流水号 |
C(1。60) |
|
非空 |
|
|
backurl |
|
回跳地址 |
N(1,32) |
传值需要URLEncode,格式报文参考 3.10.2 签约回跳接口 |
可空 |
|
|
notifyurl |
|
签约结果通知地址 |
C (1,13) |
传值需要URLEncode,签约通知格式报文参考 3.10.3 签约结果通知(310006) |
非空 |
|
|
signalg |
|
签名方式 |
C(1) |
1 国密 0 RSA |
非空 |
|
|
signstr |
|
签名值 |
|
签名内容 filename + "|" + notifyurl + "|" + backurl; |
非空 |
|
例子
https://sft-test.allinpay.com/gwsign/web/index.dsr?cusid=200604000005432&filename=WEB2006040000015913¬ifyurl=https%3A%2F%2Ftlt-test.allinpay.com%2Faipg%2Fnotifytest%3Fabc%3Dwer%26qwe%3Dasdf&backurl=https%3A%2F%2Fsft-test.allinpay.com%2Fgwsign%2Fweb%2Ftips.dsr%3Fabc%3Dwde&signalg=0&signstr=4fe01a884a142112fcb7956e2ce21848ea8581927983e42c8880ce237408dec6cd28228cd5c735fd16e7028634c798fa2a380d1ca68e661242105c0bb328f785871f5002ac54e6ccca65b5895a5a2d110679e630bc6b43686895d172393f9ea74fa597c93043367c108a204cc6bcf7594035f87b0793e4866e6833bd4d284499
生产的地址换成生产的域名 https://sft.allinpay.com