PC端生成扫码支付页面API

请求地址

生产环境
https://netpay.cmbchina.com/netpayment/BaseHttp.dll?PC_EUserPay

测试环境
http://121.15.180.66:801/netpayment/BaseHttp.dll?PC_EUserPay

请求报文

报文的参数名:jsonRequestData,参数值JSON格式见下表

参数名称 JSON键值 类型(长度) 必填 描述 示例
接口版本号 version String(3) M 固定为”1.0” 1.0
参数编码 charset String(8) M 固定为“UTF-8” UTF-8
报文签名 sign String M 使用支付密钥对reqData内的数据进行签名
签名算法 signType String M 固定为“SHA-256” SHA-256
请求数据 reqData
请求时间 dateTime String(14) M 格式:yyyyMMddHHmmss
商户发起该请求的当前时间,精确到秒
20161209112230
分行号 branchNo String(4) M 商户分行号,4位数字 0755
商户号 merchantNo String(6) M 商户号,6位数字 000054
订单日期 date String(8) M 格式:yyyyMMdd 20161209
订单号 orderNo String(32) M 支持6-32位(含6和32)间任意位数的订单号,支持不固定位数,支持数字+字母(大小字母)随意组合。由商户生成,一天内不能重复。订单日期+订单号唯一定位一笔订单。 9999000001
金额 amount String(14) M 格式:xxxx.xx
固定两位小数,最大11位整数
0.01
过期时间跨度 expireTimeSpan String(2) O 必须为大于零的整数,单位为分钟。该参数指定当前支付请求必须在指定时间跨度内完成(从系统收到支付请求开始计时),否则按过期处理。一般适用于航空客票等对交易完成时间敏感的支付请求。 30
成功支付结果通知地址 payNoticeUrl String(256) M 商户接收成功支付结果通知的地址。 http://www.merchant.com/path/payNotice.do
成功支付结果通知附加参数 payNoticePara String(256) O 该参数在发送成功支付结果通知时,将原样返回商户注意:该参数可为空,商户如果需要不止一个参数,可以自行把参数组合、拼装,但组合后的结果不能带有’&’字符。 12345678|ABCDEFG|HIJKLM
商品描述 productDesc String(40) O 1. 显示在PC端扫码支付页面
2. 在支付成功后,附加在短信通知中
3. 最大40个字节,1个中文占用2个字节
4. 支持中文、字母(大小写)、数字、空格、标点符号,任意组合
5. 不支持英文格式的单双引号、加号(+)、反斜杠(\)、&
成功页返回商户地址 returnUrl String(256) O 支付成功页面上“返回商户”按钮跳转地址。为空则不显示返回商户按钮。原生APP可传入一个特定地址(例如:Http://CMBNPRM),并拦截处理自行决定跳转交互。
支付结果前端通知API中的结果将在本地址的参数中返回。以POST的方式返回本地址。
http://www.merchant.com/path/return.do
客户IP clientIP String(64) O 商户取得的客户IP,如果有多个IP用逗号”,”分隔。 99.12.38.165
允许支付的卡类型 cardType String(1) O 默认对支付卡种不做限制,储蓄卡和信用卡均可支付
A:储蓄卡支付,即禁止信用卡支付
协议号 agrNo String(32) O 客户协议号。支持的字符集:数字、字母(大小字母)、 -_ 两个特殊字符,-_ 注意是英文半角的。
未签约(首次支付)客户,填写新协议号,用于协议开通;已签约(再次支付)客户,填写该客户已有的协议号。
商户必须对协议号进行管理,确保客户与协议号一一对应。
协议号允许为空,若协议号字段为空,则不进行签约,直接登录后完成支付。
12345678901234567890
协议开通请求流水号 merchantSerialNo String(20) C 协议开通请求流水号,开通协议时必填。 2016062014308888
商户用户ID userID String(20) O 用于标识商户用户的唯一ID。商户系统内用户唯一标识,不超过20位,数字字母都可以,建议纯数字。 2016062388888
商户用户手机号 mobile String(11) O 商户用户的手机号 18202532653
风险等级 riskLevel String(4) O 用户在商户系统内风险等级标识
成功签约结果通知地址 signNoticeUrl String(100) C 上送协议号且首次签约,必填。商户接收成功签约结果通知的地址。 http://www.merchant.com/path/signNotice.do
成功签约结果通知附加参数 signNoticePara String(128) O 该参数在发送成功签约结果通知时,将原样返回商户。注意:该参数可为空,商户如果需要不止一个参数,可以自行把参数组合、拼装,但组合后的结果不能带有’&’字符。 12345678|ABCDEFG|HIJKLM
加密类型 encrypType String O RC4:使用RC4算法对加密数据进行加密,加密密钥为支付密钥。
DES:使用DES算法对加密数据进行加密,加密密钥为商户支付密钥的前8位,不足8位则右补0。
注意:如果加密数据字段非空,该字段必填。
加密数据 encrypData String O json格式写入的加密数据,并使用encrypType指定的算法加密。
使用信息
使用encrypType指定的加密算法加密后的扩展信息。明文格式字符串格式如:{"addressCity":"440300","addressMobile":"18106989120","productType":"000518"}
注意:加密后的密文必须转换为16进制字符串

请求示例

1.json报文组织:

{
    "version":"1.0",
    "charset":"UTF-8",
    "sign":"见签名处理章节",
    "signType":"SHA-256",
    "reqData":{
        "dateTime":"20161209112230",
        "branchNo":"0755",
        "merchantNo":"000054",
        "date":"20161209",
        "orderNo":"9999000001",
        "amount":"0.01",
        "expireTimeSpan":"30",
        "payNoticeUrl":"http://www.merchant.com/path/payNotice.do",
        "payNoticePara":"12345678|ABCDEFG|HIJKLM",
        "productDesc":"商品描述",
        "returnUrl":"http://www.merchant.com/path/return.do",
        "clientIP":"99.12.38.165",
        "cardType":"A",
        "agrNo":"12345678901234567890",
        "merchantSerialNo":"2016062014308888",
        "userID":"2016062388888",
        "mobile":"18202532653",
        "riskLevel":"",
        "signNoticeUrl":"http://www.merchant.com/path/signNotice.do",
        "signNoticePara":"12345678|ABCDEFG|HIJKLM",
        " encrypData":
        "FC7788996853803BB6981F406BA84939CE96B8D57FFB20B653078B181FA9691D7CFF00D1D3EF21E6B338A3FD33690CAF12078BE885BB49F6016CF5A0314D21BF49738629F8386CB437A76A8DBE1E7E932DBDB18B7C69A8D10900FB8A3C98CB48833B5800A541DD6B5A12F65508C3BCD1D51B32DD02CCE362BB5CE4D95E5D29921E603BBE3CA5B650652589011304CC2969E2A1046F91A1849B70001FE23EA8592560BE4FB7994D51BC7E7F5F5E08474F7090A44D635F2BFD7353B081DF80613817FD357CD472392A2EFEB1DA52D72DADD3BD5725FE42FA9D4B19",
        "encrypType":"RC4"
    }
}

2.表单组织:

<form action="请求地址" method="post" >
    <input type="hidden" name="jsonRequestData" value='以上json字符串' />
    <input type="hidden" name="charset" value='utf-8' />
</form>

3.待签名字符串示例(未包含支付密钥):

agrNo=12345678901234567890&amount=0.01&branchNo=0755&cardType=A&clientIP=99.12.38.165&date=20161209&dateTime=20161209112230&encrypData=FC7788996853803BB6981F406BA84939CE96B8D57FFB20B653078B181FA9691D7CFF00D1D3EF21E6B338A3FD33690CAF12078BE885BB49F6016CF5A0314D21BF49738629F8386CB437A76A8DBE1E7E932DBDB18B7C69A8D10900FB8A3C98CB48833B5800A541DD6B5A12F65508C3BCD1D51B32DD02CCE362BB5CE4D95E5D29921E603BBE3CA5B650652589011304CC2969E2A1046F91A1849B70001FE23EA8592560BE4FB7994D51BC7E7F5F5E08474F7090A44D635F2BFD7353B081DF80613817FD357CD472392A2EFEB1DA52D72DADD3BD5725FE42FA9D4B19&encrypType=RC4&expireTimeSpan=30&merchantNo=000054&merchantSerialNo=20161209112230&mobile=18202532653&orderNo=9999000001&payNoticePara=12345678|ABCDEFG|HIJKLM&payNoticeUrl=http://www.merchant.com/path/WAPProcResult.dll&returnUrl=http://www.merchant.com/path/return.do&riskLevel=&signNoticePara=12345678|ABCDEFG|HIJKLM&signNoticeUrl=http://www.merchant.com/path/signNotice.do&userID=2016062388888 

4.扩展信息

扩展信息(encrypData)用于商户上送一些订单信息、用户信息。 json格式写入扩展信息,并使用encrypType指定的算法加密

a)扩展信息字段可以传的参数

参数名称 JSON键值 类型(长度) 必填 描述 示例
商户用户注册ID注册时间 userIDRegisterTime String(26) O 时间戳。
格式YYYY-MM-DD hh:mm:ss
2016-01-01 14:33:22
是否是24H内注册ID newRegisterFlag String(1) O Y/N Y
粗略地理位置 cityCode String(6) O 使用行政区划代码,六位 440300
订单收货城市 addressCity String(6) O 使用行政区划代码,六位 440300
订单收货人手机号 addressMobile String(11) O 11位手机号或手机号未4位。 18025369523
产品及服务标识 productType String(12) O

1)扩展信息字段的使用说明

json格式写入扩展信息,并使用encrypType指定的算法加密。加密算法如下:

首先将需传入的风控参数拼接成json,再使用RC4或DES加密生成16进制的字符串即为encrypData字段。encrypType取值为RC4时,密钥为商户支付密钥;取值为DES时,密钥为商户支付密钥的前8位,不足8位则右补0。RC4与DES算法参考附录中的RC4代码示例和DES代码示例。

响应报文

网页直接展示结果,无响应报文。
签约成功和支付成功后有异步结果通知,失败无通知。

错误码

错误码 描述 解决方案
请求参数错误:
NP1016 分行号格式错误 参数branchNo错误
商户开户分行号,4位数字,请咨询开户的招商银行分支机构;
NP1017 商户号格式错误 参数merchantNo错误
商户号,6位数字,由银行在商户开户时确定;//收单商户号
NP1020 金额格式错误 参数amount错误
订单总金额,格式为:xxxx.xx元;
NP1022 日期格式错误 参数dateTime或date错误
Date: yyyyMMdd,TS:yyyyMMddHHmmss
NP1029 订单已过期:请回到商户网站,重新生成订单 参数dateTime错误
订单已过期,请求时间和当前系统时间间隔超过30分钟
NP1034 商户通知URL地址格式错误 参数payNoticeUrl错误
格式要求:“https://”或“http://”开头
NP1035 商户通知参数超长 参数payNoticePara或signNoticePara错误
参数长度超过128个字节
NP1070 商户附加信息中,包含不允许的内容 参数payNoticePara或signNoticePara错误
参数值不允许有脚本
NP1071 订单过期时间(分钟)格式错误 参数expireTimeSpan错误
必须为大于零的整数,单位为分钟。
NP1021 订单号格式错误 参数orderNo错误
订单号,支持6-32位(含6和32)间任意位数的订单号,支持不固定位数,支持数字+字母(大小字母)随意组合。
NP1107 非法一网通支付协议号 参数agrNo错误
客户协议号。支持的字符集: 数字、字母(大小字母)、-_ 两个特殊字符,-_ 注意是英文半角的。未签约客户,填写新增的协议号,用于协议开通;签约客户,填写客户协议号。非空。
NP1108 非法一网通支付协议开通流水号 参数merchantSerialNo错误
字符串,不超过20位。协议开通时非空。
NP1109 非法协议商户号 参数merchantNo错误
由银行在商户开户时确定。非空。
NP1110 非法协议用户ID 参数userID错误
字符串,不超过20位。可为空
NP1111 非法协议手机号 参数Mobile错误
11位数字。可为空
NP1112 非法协议开通结果通知命令请求地址 参数signNoticeUrl错误
字符串,长度不超过100位。协议开通时非空。
NP1113 非法协议开通结果通知命令参数 参数signNoticePara错误
字符串,长度不超过128位。可为空
NP1124 商户URL返回地址格式错误 参数returnUrl错误
格式要求:“https://”或“http://”开头
以下是支付流程中的其他报错:
NP2001 该商户只允许使用专业版进行支付 只允许进行专业版支付的商户,不允许接入一网通支付
NP2028 该商户不允许进行协议支付 商户不在一网通支付白名单中
NP4010 查询协议支付信息失败 查询客户协议信息失败(与中间业务通讯),后面会有具体错误原因: 后台返回的错误信息:此时根据提示进行处理或找后台系统接口人进行处理。 错误信息中带错误码“NP8016”:与后端系统通讯失败。联系后台处理人察看系统运行情况
NP4011 查询一网通用户信息失败 查询一网通用户状态失败(与一网通BServer通讯),后面会有具体错误原因: 后台返回的错误信息:此时根据提示进行处理或找后台系统接口人进行处理。 错误信息中带错误码“NP8005”:与后端系统通讯失败。联系后台处理人察看系统运行情况
NP4012 一网通用户状态异常 查询一网通用户状态成功,但用户状态异常。根据提示信息进行相应处理。
NP4013 查询绑定卡列表信息失败 查询绑定卡片列表失败(与一网通BServer通讯,BServer后台对接综合支付平台),后面会有错误原因: 后台返回的错误信息:此时根据提示进行处理或找后台系统接口人进行处理。 错误信息中带错误码“NP8005”:与后端系统通讯失败。联系后台处理人察看系统运行情况
NP4014 抱歉,您解绑了所有卡片,目前绑定卡列表为空,请绑定后重试 客户绑定卡片列表中无“支付卡”。
NP0020 请求处理失败,请重新提交 支付密码解密失败(一般是商户公钥与系统配置的私钥不匹配)
NP4004 支付请求处理失败 支付请求提交失败(与NPSServer通讯,BServer后台对接收单),后面会有错误原因: 后台返回的错误信息:此时根据提示进行处理或找后台系统接口人进行处理。 错误信息中带错误码“NP8005”:与后端系统通讯失败。联系后台处理人察看系统运行情况
NP8005 BServer业务处理通讯失败 与BServer系统通讯失败。需根据场景进行分析:1、如填写完支付密码提交时报错,参看错误码NP4004中“NP8005”处理
NP1122 无效订单:签名验证失败 Sign加密签名不匹配,检查参数排序是否一致,参数是否按规定来传,算法是否正确
NP1123 参数格式不正确 检查json格式是否正确
NP1125 商户编码错误 检查是否使用了规定的编码方式
NP1126 商户请求方式错误 检查是否使用了规定的请求方式,只支持Post方式
NP1128 扩展信息解密错误或扩展信息格式错误 EncrypData加密算法有误或参数数据格式错误
NP1129 扩展信息加密类型错误 EncrypType未送RC4或DES

关于网站迁移公告


为提供更优质的开发技术支持,本网站已于2019年8月12日正式迁移至新域名http://openhome.cmbchina.com/paynew/pay/Home,敬请访问并收藏。原网站域名已停止更新维护,请以新网站提供的文档信息为准。

由此给您带来的不便,敬请谅解。


招商银行一网通支付技术支持小组

2019年8月12日