商户入驻
文档说明
阅读对象
1、本规范的使用对象为服务商的技术开发人员、产品及业务。2、开发人员应该对post提交、json 格式、http/https传输、非对称秘钥和数据签名等有一定认识。
修订记录
2019-05-06:新增
相关术语
商户入驻:服务商通过入驻接口在汇付为商户进行开户,支持开通银行卡支付(包括银联二维码)、微信和支付宝扫码业务。
接口规则
协议规则
1、接口调用方式为http post。2、数据传输使用json格式,编码使用utf-8,请求时存放json串的参数名为: jsonData,接口传递中文或含有特殊字符的参数时应URL Encoding,接口接收返回参数时应做URL Decoding。3、如果json请求串中值为null,则json串格式应为{“test”: “”}。4、接口的除merPriv字段之外,其他所有字段不应该包含特殊字符,如:”&”、”?”和”‘’”等。5、后台通知商户返回应答参数的规则:为了表示商户交易系统已经收到交易应答,商户必须在应答接收页面输出一段特殊的字符串,组成规则为:固定字符串RECV_ORD_ID_加上交易应答中某一指定字段,指定字段请见具体接口商户应答参数。
安全规范
1、为了保证数据传输过程中的数据真实性和完整性,我们需要对数据进行数字签名,在接收签名数据之后进行签名校验。2、详情请参见接口参数checkValue参数说明。3、checkValue生成规则:目前仅支持CFCA签名方式,checkValue生成方法请参考CFCA签名。简单示例:
HashMap<String , String> jsonDataMap = new HashMap<String , String>();
jsonDataMap.put("termOrdId" , "20180820020626985855");
jsonDataMap.put("memberId" , memberId);
jsonDataMap.put("ordAmt" , ordAmt);
jsonDataMap.put("authCode" , "134755413751742262");//二维码
jsonDataMap.put("goodsDesc" , URLEncoder.encode(goodsDesc , Constant.CHARSET_UTF8));
jsonDataMap.put("merPriv" , "{\"Ic\":\"2253425259\",\"merNoticeUrl\":\"http://172.31.13.182:38087/site/testHttp/testB/\",\"callType\":\"04\"}");
jsonDataMap.put("apiVersion" , apiVersion);
String jsonData = JSON.toJSONString(jsonDataMap);
// CFCA 签名
String checkValue = CFCASignature.signature("100001.pfx","888888", jsonData, "UTF-8").getSign();
商户入驻
场景介绍
服务商通过入驻接口在汇付为商户进行开户,支持开通银行卡支付(包括银联二维码)、微信和支付宝扫码业务。
功能描述
服务商通过调用以下接口进行商户入驻相关业务。1、商户基本信息入驻接口:商户入驻所需基本信息,包括结算卡信息、经营信息等。2、商户业务开通接口:支持开通银行卡支付(包括银联二维码)、微信和支付宝扫码业务。开通方式灵活,支持补开。3、商户基本信息修改接口:信息填写有误或未通过审核时可用此接口修改基本信息。4、商户信息查询接口:查询商户基本信息、业务信息、结算信息等全量信息。5、商户入驻结果查询:调用此接口查询商户入驻的结果,如因某些异常原因,服务商未收到进件的异步通知,可以主动发起查询。6、商户图片上传接口:用于上传商户入驻接口中所需要的图片。7、微信风控接口:商户入驻微信时提供给服务商根据身份证、银行卡、营业执照等信息查询商户是否有风险。
业务流程
接口进件流程概述
1、与商务签订协议,拿到汇付渠道商号。2、登录服务商控台 https://nspos.chinapnr.com/nsposmweb/login 代理商管理->代理商新增页面->新建代理商,同时填写 移动支付商户资料表格 申请微信子渠道号(根据需要,是否要给商户配置渠道商自己的微信参数)。3、代理商账号建立好,确定微信子渠道号与代理商号已绑定,可在此代理商下进件。4、进件共三种方式:接口进件、控台批量进件、控台单个进件。接口调用顺序A、调用商户基本信息入驻接口完成开户B、调用商户业务开通接口选择需要开通的业务C、调试交易说明a、开通银行卡业务时需要上传图片且需要人工审核,开通银行卡需要上传图片,上传图片详情见 直销商户入网标准b、小微商户可调用此接口完成入驻,如需开通微信和支付宝支付(不支持开通”银行卡支付”业务),在调用业务开通接口时,参数说明中:”标注为”业务开通必填”的字段请务必传入”
接口进件流程图
1、开通支付宝&微信进件流程2、开通银行卡&银联二维码&支付宝&微信流程
结算相关业务配置说明
D+1结算:自然日结算,需收取结算手续费,可在商户基本信息入驻接口中选择开通。D+1手续费外扣:结算手续费不从实际交易商户中扣除,可配置由代理商或渠道商扣除,在商户基本信息入驻接口中开通。D0:当日取现功能,可在商户基本信息入驻接口中选择开通。延迟入账:交易额暂不进行结算,渠道商调用交易确认接口时按照约定方式结算,可在商户基本信息入驻接口中开通。D0业务与延迟入账业务互斥,不可同时开通。交易手续费外扣:商户发生交易的手续费可由代理商或渠道商代付,可在商户业务开通接口中开通。
微信实名认证基本校验规则
1)去微信实名认证,需要先判断是否资质齐全
所需资质相关的图片请通过【商户图片上传接口】进行上传资质是否齐全的判断,以”主体类型”为维度可划分为:A.企业、个体工商户;参数与原有进件保持一致。需要上送营业执照图片,法人证件照片(身份证正反面,其他证件正面);B.事业单位或其他组织;需新增必传参数:证书类型;需上送”单位证明函照片”;新增图片类型, 政府、事业单位开通微信必须上传证明函文件 CERTIFICATE_FILE,文件样式具体参照C.小微商户;个人商户基本信息入驻接口需新增参数:小微经营类型(如需微信实名认证必填),其他参数延用现有字段;1.门店场所:MICRO_TYPE_STORE2.流动经营/便民服务:MICRO_TYPE_MOBILE3.线上商品/服务交易:MICRO_TYPE_ONLINE小微商户上送图片需有”门店门头照片”、”店内环境照片”;注意,图片不能超过2MB,系统自动处理上送通道。汇付上送微信报备的商户名称为”商户_***”,***为小微商户结算人即法人的姓名。2)接口对接方面:
a、如果对接的是老的进件接口:如果是企业或个体工商户,还是调用【商户入驻申请接口】如果是小微商户,需对接新接口,请调用【个人商户基本信息入驻接口】+【商户业务开通接口】b、如果对接的是新的进件接口:如果是企业或个体工商户,请调用【企业商户基本信息入驻接口】+【商户业务开通接口】如果是小微商户,请调用【个人商户基本信息入驻接口】+【商户业务开通接口】c、【商户业务开通接口】,以及【商户入驻申请接口】(老接口)新增字段”是否微信实名认证”,此字段为非必传字段,该字段为空值,则走原有报备逻辑,获取二级商户号后直接返回结果,如需要做认证,则字段传”1”,则走新逻辑;3)微信实名认证申请单审核接口
微信实名认证申请单审核接口信息都存现有报备流程中,具体申请单状态比如返回联系人签约二维码或者驳回原因通过【商户业务开通查询接口】透传给服务商;老接口通过【商户入驻结果查询】返回字段新增【微信实名认证重认证】接口,用于商户修改信息、资质完成后,发起重新认证的指令,智汇管家对微信发起撤单、提交申请单指令;如果申请单已作废,或者没有申请单,则直接提交申请单。针对存量商户或者新商户认证被驳回,可以调用该接口重新发起认证。补认证流程也可以智汇管家控台进行再次发起,操作路径:智汇管家-服务商控台-商户信息查询-实名认证4)新增微信实名认证接口
调用该接口,可以查询到商户的微信子商户号以及对应的授权状态或者申请单状态。
API列表
企业商户基本信息入驻接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式:CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定:2.0.0.1 |
|
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号 |
|
merchType |
商户类型 |
String(1) |
非必填 |
1:连锁商户
2:单店
不填,默认2-单店
|
|
merHeader |
所属总部编号 |
String(32) |
条件必填 |
可登录服务商控台->连锁商户组织架构修改菜单查询
或通过总部查询接口获取,商户类型为总店模式时所属总部编号必填
|
|
opTellerId |
代理商操作员 |
String(32) |
必填 |
代理商操作员号 |
|
merchName |
商户注册名称 |
String(60) |
必填 |
||
provId |
经营地址所在省 |
String(32) |
必填 |
参照《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如河北省, 请填写河北
|
|
cityId |
经营地址所在市 |
String(32) |
必填 |
参照《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如唐山市, 请填写唐山市
|
|
areaId |
经营地址所在区县 |
String(32) |
必填 |
参照《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如XX区, 请填写XX区
|
|
merchAddr |
商户经营详细地址 |
String(240) |
必填 |
填写商户实际的经营详细地址。
长度说明:80个字符, 最多40个汉字
|
|
merchShort
Name
|
商户简称 |
String(32) |
必填 |
简称格式:地区+商户名称+行业 |
|
business
Shours
|
营业开始时间 |
String(5) |
必填 |
格式要求:09:00 |
|
business
Ehours
|
营业结束时间 |
String(5) |
必填 |
格式要求:22:00 |
|
tellerId |
管理员账号 |
String(6-32) |
必填 |
建议使用手机号或联系人姓名拼音+生日
避免重复
|
|
isSendMes |
是否发送短信
通知商户
|
String(1) |
必填 |
发送短信通知商户联系人, 包含控台地址
管理员账号、密码 1:是, 0:否
|
|
contactName |
商户联系人 |
String(30) |
必填 |
商户联系人姓名。支持少数名族,
最大支持15个汉字
|
|
contactId
Type
|
联系人证件类型 |
String(2) |
必填 |
选项:01:身份证、02:护照、04:军官证、
03:港澳台通行证、05:回乡证、
06:工商登记号、09:其他
|
|
contactIdNo |
联系人证件号码 |
String(40) |
必填 |
||
contactId
ValidType
|
联系人证件有效期 |
String(1) |
必填 |
1-非长期
2-长期
|
|
contactId
Sdate
|
联系人证件有效期
开始日期
|
String(8) |
必填 |
日期格式要求:20180115 |
|
contactId
Edate
|
联系人证件有效期
结束日期
|
String(8) |
条件必填 |
选择非长期填写,日期格式要求:20180115 |
|
contactTelno |
联系人手机 |
String(11) |
必填 |
手机号格式 |
|
contactEmail |
联系人邮箱 |
String(40) |
必填 |
邮箱格式 |
|
csTel |
客服电话 |
String(20) |
非必填 |
支持固话格式, 手机格式 |
|
isPrivate |
结算账户类型 |
String(1) |
必填 |
0-对公
1-对私
|
|
bankActName |
结算账户名 |
String(30) |
必填 |
结算账户名称 |
|
bankActId |
结算账号 |
String(30) |
必填 |
结账账号 |
|
bankProvId |
银行所在省 |
String(32) |
必填 |
参考《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如河北省, 请填写河北
|
|
bankCityId |
银行所在市 |
String(32) |
必填 |
参考《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如唐山市, 请填写唐山市
|
|
bankName |
银行名称 |
String(32) |
必填 |
||
bankUnion
Code
|
银行联行号 |
String(12) |
条件必填 |
对公结算时, 联行号字段与支行名称二选一 |
|
subBankName |
支行名称 |
String(30) |
条件必填 |
对公结算时, 联行号字段与支行名称二选一 |
|
settleTerm |
结算周期 |
String(1) |
必填 |
1-(T+1 工作日结算)
2-(D+1 自然日结算)
|
|
fee01 |
D+1结算手续费(%) |
String(1) |
必填 |
选择结算周期:D+1时必填 |
|
settle
Business
|
结算业务开通 |
String(8) |
非必填 |
01-D0提现, 02-延迟入账(开通了延迟入账的
商户需要交易确认后才可入账, 确认后的
资金将根据商户的结算周期进行打款)
03-D1手续费外扣
支持01-D0和02-延迟入账同时开通
|
|
fee28 |
D0结算(提现)手续费(%) |
String(10) |
非必填 |
选择结算业务为01时必填(%) (D0取现手续费) |
|
fee01MerId |
D1外扣账户 |
String(18) |
条件必填 |
选择结算业务为03时必填 |
|
settleRemark |
结算摘要 |
String(200) |
非必填 |
默认为空 如果需要自定义结算打款备注,
请使用此字段传入, 字段类型为字符串
|
|
isCreditCode |
是否三证合一 |
String(1) |
条件必填 |
企业商户必填, 选项:0, 否;1, 是。
选择是:填写信用代码证编号;
选择否:填写营业执照编号。
|
|
creditCode |
统一社会
信用代码证
|
String(18) |
条件必填 |
三证合一选择是填写 |
|
regCode |
营业执照编号 |
String(30) |
条件必填 |
三证合一选择否填写 |
|
licType |
证照有效期 |
String(1) |
非必填 |
1-非长期
2-长期
|
|
licSdate |
证照开始日期 |
String(8) |
必填 |
日期格式要求:20180115 |
|
licEdate |
证照结束日期 |
String(8) |
必填 |
选择非长期填写, 日期格式要求:20180115 |
|
orgCode |
组织机构代码证 |
String(10) |
条件必填 |
三证合一选择否填写 |
|
legalName |
法人 |
String(20) |
条件必填 |
企业用户必填, 法人姓名。
支持少数名族,最大支持20个汉字。
|
|
idType |
法人证件类型 |
String(2) |
条件必填 |
企业用户必填, 选项:01:身份证、02:护照
04:军官证、03:港澳台通行证、05:回乡证
06:工商登记号、09:其他
|
|
idNo |
法人证件号码 |
String(40) |
条件必填 |
企业用户必填 |
|
idValidType |
法人证件有效期 |
String(1) |
条件必填 |
企业用户必填, 选项:1, 非长期;2, 长期 |
|
idSdate |
法人证件有效期
开始日期
|
String(8) |
条件必填 |
企业用户必填, 日期格式要求:20180115 |
|
idEdate |
法人证件有效期
证件结束日期
|
String(8) |
条件必填 |
选择非长期填写, 日期格式要求:20180115 |
|
accountId
Type
|
持卡人证件类型 |
String(2) |
条件必填 |
对私结算时必填 选项:01:身份证、
02:护照、04:军官证、03:港澳台通行证、
05:回乡证、06:工商登记号、09:其他
|
|
accountIdNo |
持卡人证件号码 |
String(40) |
条件必填 |
对私结算时必填, 持卡人证件号码 |
|
accountId
ValidType
|
证件有效期 |
String(1) |
条件必填 |
对私结算时必填 选项:1:非长期;2:长期 |
|
accountId
Sdate
|
证件有效期
开始日期
|
String(8) |
条件必填 |
对私结算时必填 日期格式要求:20180115 |
|
account
IdEdate
|
证件有效期
结束日期
|
String(8) |
条件必填 |
选择非长期填写 日期格式要求:20180115 |
|
merchClass |
商户性质 |
String(1) |
条件必填 |
默认为企业商户 枚举值: 1.企业商户 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一, 查询时使用 |
|
pnrpay
MerType
|
商户种类 |
String(1) |
必填 |
1-政府机构
2-国营企业
3-私营企业
4-外资企业
5-个体工商户
7-事业单位
9-其它组织
|
|
certType |
证书类型 |
String(50) |
非必填 |
进行微信实名认证必填
当主体为事业单位时,选择此枚举值
CERTIFICATE_TYPE_2388:事业单位法人证书
当主体为政府机关,选择此枚举值
CERTIFICATE_TYPE_2389:统一社会信用代码证书
当主体为其它组织,选择以下枚举值之一
CERTIFICATE_TYPE_2389:统一社会信用代码证书
CERTIFICATE_TYPE_2394:社会团体法人登记证书
CERTIFICATE_TYPE_2395:民办非企业单位登记证书
CERTIFICATE_TYPE_2396:基金会法人登记证书
CERTIFICATE_TYPE_2520:执业许可证/执业证
CERTIFICATE_TYPE_2521:基层群众性自治组织
特别法人统一社会信用代码证
CERTIFICATE_TYPE_2522:农村集体经济组织登记证
CERTIFICATE_TYPE_2399:宗教活动场所登记证
CERTIFICATE_TYPE_2400:政府部门下发的其
他有效证明文件
|
|
countryType |
法人护照国籍 |
String(3) |
非必填 |
法人证件为护照的时候,选项为:
USA:美国 AUS:澳大利亚
JPN:日本 BRA:巴西
KOR:韩国 CAN:加拿大
FRA:法国 HKG:中国香港
GER德国 OMA:中国澳门
GBR英国 TPE:中国台北
ITA意大利 RUS俄罗斯
ESP西班牙
|
|
openLicenceNo |
开户许可核准号 |
String(32) |
条件必填 |
当注册和经营地址地址为如下地区时此字段为必填
浙江,海南,重庆,河南,江苏,宁波市,黑龙江,吉林
,湖南,贵州,陕西,湖北
|
|
bankPhone |
结算人手机号 |
String(11) |
条件必填 |
同上,当注册和经营地址地址为如下地区时此字段为必填
浙江,海南,重庆,河南,江苏,宁波市,黑龙江,吉林
,湖南,贵州,陕西,湖北
|
|
legalAddress |
法人居住地址 |
String(400) |
条件必填 |
企业商户进行微信实名则必填
请按照证件上住址填写,若证件上无
如广东省深圳市南山区xx路xx号xx室
|
|
owner |
法人是否为受益人 |
String(1) |
非必填 |
1-是
0-否 不填则默认1
|
|
uboJsonData |
受益人信息 |
JSONArray |
非必填 |
法人是否为受益人选择否则必填,最多可填写5个,见下方字段详解
|
|
uboJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
uboName |
受益人姓名 |
String(20) |
必填 |
||
uboIdType |
受益人证件类型 |
String(2) |
必填 |
01:身份证 02:护照 04:军官证 03:港澳台通行证
05:回乡证 06:工商登记号 09:其他
|
|
uboIdNo |
受益人证件号码 |
String(40) |
必填 |
||
uboAddress |
受益人地址 |
String(400) |
必填 |
请按照证件上住址填写,若证件上无住址则按照实际住址填写
如广东省深圳市南山区xx路xx号xx室
|
|
uboIdStart |
受益人证件开始日期 |
String(8) |
必填 |
示例值:19840728
|
|
uboIdValidType |
受益人证件有效期类型 |
String(1) |
必填 |
1-非长期 2-长期
|
|
uboIdEnd |
受益人证件结束日期 |
String(8) |
非必填 |
受益人证件有效期类型选择1-非长期时必填,示例值:20300822
|
|
uboIdCopy |
受益人证件正面 |
String(40) |
非必填 |
微信实名认证则必填
|
|
uboIdBack |
受益人证件反面 |
String(40) |
非必填 |
微信实名认证则必填
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
选项:000000表示成功,其余表示失败 |
|
respResp |
返回描述 |
String(256) |
必填 |
||
jsonData |
Json字符串 |
String |
非必填 |
jsonData数据, 内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
商户号 |
String(18) |
非必填 |
固定18位 ,汇付分配的商户号 |
|
merchName |
商户注册名称 |
String(60) |
非必填 |
商户注册名称, 与输入返回一致 |
|
applyNo |
申请单号 |
String(20) |
非必填 |
汇付返回商户开户业务申请单号 |
个人商户基本信息入驻接口
功能描述
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式:CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定:2.0.0.1 |
|
agentId |
代理商会员号 |
String(18) |
必填 |
代理商会员号 |
|
opTellerId |
代理商操作员 |
String(32) |
必填 |
代理商操作员号 |
|
merchName |
商户注册名称 |
String(60) |
必填 |
小微商户商户名称应填”商户_XXX”
(XXX为小微商户身份证上的姓名)
|
|
merchShort
Name
|
商户简称 |
String(32) |
必填 |
简称格式:地区+商户名称+行业 |
|
tellerId |
管理员账号 |
String(6-32) |
必填 |
建议使用手机号或联系人姓名拼音+生日
避免重复
|
|
isSendMes |
是否发送短信
通知商户
|
String(1) |
必填 |
发送短信通知商户联系人,包含控台地址
管理员账号、密码 1:是,0:否
|
|
settleTerm |
结算周期 |
String(1) |
必填 |
选项:1-T+1;2-D+1 |
|
fee01 |
D+1结算手
续费(%)
|
String(1) |
非必填 |
选择结算周期为D+1时必填 |
|
settle
Business
|
结算业务 |
String(8) |
非必填 |
01-D0,02-延迟入账(开通了延迟入账的
商户需要交易确认后才可入账,确认后的
资金将根据商户的结算周期进行打款)
03-D1手续费外扣;
以”|”分割
支持01-D0和02-延迟入账同时开通
|
|
fee28 |
D0手续费 |
String(10) |
条件必填 |
选择结算业务为01时必填(%) |
|
fee01MerId |
D1外扣账户 |
String(18) |
条件必填 |
选择结算业务为03时必填 |
|
contactName |
联系人姓名 |
String(30) |
非必填 |
商户联系人姓名。支持少数名族,最大支持15个汉字
业务开通必填
|
|
contactTelno |
联系人手机 |
String(11) |
必填 |
手机号格式 |
|
contactId
Type
|
联系人证件类型 |
String(2) |
非必填 |
选项:01:身份证、02:护照、04:军官证、
03:港澳台通行证、05:回乡证、
06:工商登记号、09:其他
与联系人证件号码同时为空或同时非空
业务开通必填
|
|
contactIdNo |
联系人证件号码 |
String(40) |
非必填 |
与联系人证件类型同时为空或同时非空
业务开通必填
|
|
bankProvId |
银行所在省 |
String(32) |
必填 |
- 参考《智能收单商户入驻申请接口文档-
- 附录》中的《附录1 省份地区对照表》
- 比如河北省,请填写河北
|
|
bankCityId |
银行所在市 |
String(32) |
必填 |
- 参考《智能收单商户入驻申请接口文档-
- 附录》中的《附录1 省份地区对照表》
- 比如唐山市,请填写唐山市
|
|
bankName |
银行名称 |
String(32) |
必填 |
||
bankActName |
结算账户名 |
String(30) |
必填 |
结算账户名称 |
|
bankActId |
结算账号 |
String(30) |
必填 |
结账账号 |
|
accountId
Type
|
结算人证件类型 |
String(2) |
必填 |
选项:01:身份证、02:护照、04:军官证、
03:港澳台通行证、05:回乡证、
06:工商登记号、09:其他
|
|
accountIdNo |
结算人证件号码 |
String(40) |
条件必填 |
||
accountId
ValidType
|
结算人证件有效期 |
String(1) |
必填 |
选项:1,非长期;2,长期 |
|
accountId
Sdate
|
结算人证件
有效期开始日期
|
String(8) |
必填 |
yyyyMMdd |
|
account
IdEdate
|
结算人证件
有效期结束日期
|
String(8) |
条件必填 |
选择非长期填写,yyyyMMdd |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一,查询时使用 |
|
settleRemark |
结算摘要 |
String(200) |
非必填 |
默认为空 如果需要自定义结算打款备注,
请使用此字段传入,字段类型为字符串
|
|
provId |
经营地址所在省 |
String(32) |
必填 |
参照《智能收单商户入驻申请接口文档
附录》中的《附录1 省份地区对照表》
比如河北省, 请填写河北
业务开通必填
|
|
cityId |
经营地址所在市 |
String(32) |
必填 |
-参照《智能收单商户入驻申请接口文档-
-附录》中的《附录1 省份地区对照表》
-比如唐山市, 请填写唐山市
业务开通必填
|
|
areaId |
经营地址所在区县 |
String(32) |
必填 |
-参照《智能收单商户入驻申请接口文档-
-附录》中的《附录1 省份地区对照表》
-比如XX区, 请填写XX区
业务开通必填
|
|
merchAddr |
商户经营详细地址 |
String(240) |
必填 |
填写商户实际的经营详细地址。
长度说明:80个字符, 最多40个汉字
业务开通必填
|
|
contactEmail |
联系人邮箱 |
String(40) |
必填 |
邮箱格式
业务开通必填
|
|
csTel |
客服电话 |
String(20) |
必填 |
支持固话格式,手机格式
业务开通必填
|
|
microBizType |
小微经营类型 |
String(20) |
必填 |
进行实名认证时必填
MICRO_TYPE_STORE:门店场所
MICRO_TYPE_MOBILE:流动经营/便民服务
MICRO_TYPE_ONLINE:线上商品/服务交易
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
示例:000000成功 其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
||
jsonData |
Json字符串 |
String |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
商户号 |
String(18) |
非必填 |
固定18位 ,汇付分配的商户号 |
|
merchName |
商户注册名称 |
String(60) |
非必填 |
商户注册名称,与输入返回一致 |
|
applyNo |
申请单号 |
String(20) |
非必填 |
汇付返回商户开户业务申请单号 |
总部信息查询接口
功能描述
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式:CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定:2.0.0.1 |
|
agentId |
代理商会员号 |
String(18) |
必填 |
代理商会员号 |
|
merHeadName |
总部名称 |
String(64) |
非必填 |
所属总部名称 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
示例:000000成功 其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
||
jsonData |
Json字符串 |
String |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
merHeadList |
总部列表 |
JSONArray |
非必填 |
||
merHeadList |
merHeader |
总部编号 |
String(21) |
非必填 |
|
merHeadName |
总部名称 |
String(64) |
非必填 |
商户业务开通接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式: CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定: 2.0.0.2 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一, 查询时使用 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号 |
|
contractNum |
合同编号 |
String(20) |
必填 |
合同编号 |
|
signName |
签约业务经理 |
String(32) |
必填 |
例如: 张三 |
|
signDate |
签约日期 |
String(8) |
必填 |
格式: YYYYMMDD 例如: 20190121 |
|
signSdate |
合同有效期
开始日期
|
String(8) |
必填 |
格式: YYYYMMDD 例如: 20190121 |
|
signEdate |
合同有效期
结束日期
|
String(8) |
必填 |
格式: YYYYMMDD 例如: 20190121 |
|
outFeeAuth |
是否交易
手续费外扣
|
String(1) |
必填 |
1-是;0-否(不填则为否) |
|
feeMemberId |
交易手续费
外扣账户
|
String(18) |
非必填 |
代理商会员号或渠道商会员号 |
|
asynNotify
URL
|
异步通知地址 |
String(120) |
必填 |
公网可以访问 |
|
yhJsonData |
银行卡支付 |
String |
非必填 |
开通业务数据, 不能同时为空。参
照下面字段说明 例如:”yhJsonData”:
[{“fee02”:”0.5”, “fee03”:”0.5”,
“fee04”:”18”,”fee05”:”0.5”,
“fee06”:”0.5”, “fee07”:”18”}]
“ylJsonData”:[{“fee23”:”0.5”,
“fee24”:”18”,”fee25”:”0.5”,
“mcc”:”6051”}]
“wxJsonData”:
[{“feeRate”:”0.5”,”payScene”:”04”,
payChannelId”:”NS002”,
“mcc”:”112”}]
“alJsonData”:
[{“feeRate”:”1”,”payScene”:”04”,
“payChannelId”:”NS002”,
“mcc”:”2015050700000000”}]
“qrcJsonData”:
[{“fee23”:”0.5”,”fee24”:”18”,”fee25”:”0.5”
“fee38”:”0.5”,”fee39”:”0.5”,”mchntType”:”7299”
“merLng”:”10.00”,”merLat”:”10.00”}]
|
|
ylJsonData |
银联二维码支付 |
String |
非必填 |
||
wxJsonData |
微信支付 |
ArrayList |
非必填 |
||
alJsonData |
支付宝支付 |
ArrayList |
非必填 |
||
qrcJsonData |
银联小微支付 |
String |
非必填 |
||
chargeCate
Code
|
银行业务 手续费类型 |
String(2) |
条件必填 |
银行卡支付和银联二维码支付开通时
01见面类02优惠类03标准类
|
|
regProvName |
注册地址所在省 |
String(32) |
条件必填 |
银行卡支付和银联二维码支付开通时
必填,省编名称, 例如: 安徽
|
|
regCityName |
注册地址所在市 |
String(32) |
条件必填 |
银行卡支付和银联二维码支付开通时
必填,市编名称,例如: 合肥市
|
|
regAreaName |
注册地址所在区县 |
String(32) |
条件必填 |
银行卡支付和银联二维码支付开通时
必填,区/县编名称, 例如: 政务区
|
|
regAddr |
商户注册详细地址 |
String(80) |
条件必填 |
银行卡支付和银联二维码支付开通时
必填,商户注册详细地址
|
|
archFlph09 |
商务协议 |
String(60) |
条件必填 |
仅开通扫码类业务,如微信、支付宝
、银联二维码不强制传此图片
|
|
archFlph01 |
营业执照图片 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph02 |
税务登记证 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph03 |
组织机构代码证 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph04 |
开户许可证 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph05 |
法人身份证正面 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph06 |
法人身份证反面 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph10 |
公司照片一 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph11 |
公司照片二 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph12 |
公司照片三 |
String(60) |
条件必填 |
企业商户必填 |
|
archFlph18 |
结算卡正面 |
String(60) |
条件必填 |
对私结算填写 |
|
archFlph19 |
结算卡反面 |
String(60) |
条件必填 |
对私结算填写 |
|
archFlph07 |
结算人身份证正面 |
String(60) |
条件必填 |
个人商户必填 |
|
archFlph08 |
结算人身份证反面 |
String(60) |
条件必填 |
个人商户必填 |
|
archFlph13 |
联系人身份证正面 |
String(60) |
条件必填 |
以下情况需要填写
1.个人商户必填
2.企业商户联系人非法人进行微信实名认证时必填
|
|
archFlph14 |
联系人身份证反面 |
String(60) |
条件必填 |
以下情况需要填写
1.个人商户必填
2.企业商户联系人非法人进行微信实名认证时必填
|
|
archFlph15 |
店铺门头照 |
String(60) |
条件必填 |
小微商户进行微信实名认证必填 |
|
archFlph17 |
店内环境照片 |
String(60) |
条件必填 |
小微商户进行微信实名认证必填 |
|
archFlph32 |
单位证明函 |
String(60) |
条件必填 |
事业单位进行微信实名认证必填 |
|
archFlph39 |
结算人手持授权委托书 |
String(60) |
非必填 |
||
archFlph40 |
业务办理授权函 |
String(60) |
非必填 |
企业商户联系人非法人进行微信实名认证必填
|
|
needAuthorize |
是否微信实名认证 |
String(1) |
条件必填 |
1:进行微信实名认证
2:不进行微信实名认证不传则不进行实名认证
|
|
yhJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
指开通银行卡业务需要的参数,包括HUAWEI pay,apple pay等 |
||||
fee02 |
借记卡手续费(%) |
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee05 |
云闪付借记卡
手续费(%)
|
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee04 |
借记卡封顶值 |
String(8) |
必填 |
大于零的数字, 单位元。例如:18 |
|
fee07 |
云闪付借记
卡封顶(元)
|
String(8) |
必填 |
大于零的数字, 单位元。例如: 18 |
|
fee03 |
贷记卡手续费(%) |
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee06 |
云闪付贷记卡
手续费(%)
|
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
ylJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
指开通银联二维码业务 |
||||
fee23 |
借记卡手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
fee24 |
借记卡封顶 |
String(8) |
必填 |
正数,最长保留4位小数,单位元。例如:18 |
|
fee25 |
银联二维码借记
卡手续费率(%)
|
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee28 |
银联二维码借记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
fee29 |
银联二维码贷记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银联二维码经营类目表
|
|
wxJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
payScene |
支付场景 |
String(16) |
必填 |
01 APP支付 (目前不支持)
02 线上公众号支付
03 线上小程序支付
04 线下公众号支付
05 线下微信小程序(使用前需先开通04)
08 教培/医疗机构
09 校园餐饮
10 教育K12
|
feeRate |
手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银微信支付经营类目表 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值:如果在汇付申请了微信渠道号或支付宝渠道号,
在开通微信支付或支付宝支付时,请根据需要传入汇付分配的子渠道号
|
|
subsidyFeeRate |
补贴费率 |
String(4) |
非必填 |
只适用于教培(08)场景使用小数,最长保留4位小数,
例如:0.5-表示千分之五的手续费
|
|
alJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
payScene |
支付场景 |
String(16) |
必填 |
枚举值04 扫码
|
feeRate |
手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银微信支付经营类目表 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值:如果在汇付申请了微信渠道号或支付宝渠道号,
|
|
aliClsCode |
行业分类 |
String(4) |
非必填 |
支付宝MCC
|
|
qrcJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
fee23 |
借记卡手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
fee24 |
借记卡封顶 |
String(8) |
必填 |
正数,最长保留4位小数,单位元。例如:18 |
|
fee25 |
银联二维码贷记
卡手续费率(%)
|
String(8) |
必填 |
手续费保留小数点后4位。如:0.5533 |
|
fee38 |
银联二维码借记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
fee39 |
银联二维码贷记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
mchntType |
商户类型 |
String(4) |
必填 |
商户类型,不是MCC
|
|
merLng |
经度 |
String(20) |
必填 |
||
merLat |
纬度 |
String(20) |
必填 |
同步返回参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
respCode=000000 仅表示异步通知已成功发送,
业务开通状态请根据notifyType+businessStat来判断
|
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
||
checkValue |
加签密文 |
String |
必填 |
加密算法使用: cfca签名 |
|
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据, 内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
reqSerialNum |
原请求流水号 |
String(120) |
必填 |
|
agentId |
代理商号 |
String(18) |
必填 |
||
memberId |
商户号 |
String(18) |
必填 |
||
applyNo |
商户申请单号 |
String(18) |
必填 |
||
businessStat |
业务开通申请单
受理状态
|
String(1) |
必填 |
同步返回成功表示”受理成功”,业务
开通结果请以异步通知中的”通知类型”
和”业务开通状态”为准
|
异步通知返回参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
加密算法使用: cfca签名 |
|
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据, 内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
seqId |
流水号 |
String(20) |
必填 |
|
reqSerialNum |
原请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一, 查询时使用 |
|
notifyType |
通知类型 |
String(2) |
必填 |
01: 申请单审核状态
02: 银行卡业务开通业务
03: 银联二维码业务开通
04: 微信支付业务开通
05: 支付宝业务开通
06: 微信小程序
07 :APP支付
08 :线上公众号支付
09 :线上小程序支付
10 :微信教培业务
11 :校园餐饮
12 :教育K12
|
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值 |
|
respCode |
返回码 |
String(6) |
必填 |
||
respDesc |
返回文字说明 |
String(256) |
非必填 |
||
memberId |
商户号 |
String(18) |
非必填 |
固定18位 ,汇付分配的商户号 |
|
businessStat |
业务开通状态 |
String(2) |
非必填 |
01: 已开通
02: 未开通
03: 开通失败
04: 申请单审核拒绝
|
|
smId |
二级商户号 |
String(20) |
非必填 |
微信/支付宝入驻的真实商户号 |
|
busiFailMsg |
业务开通失败原因 |
String (256) |
非必填 |
businessStat为03或04时返回具体失败原因 |
|
接收异步 |
|||||
应答格式: |
RECV_ORD_ID_{ seqId } |
商户业务开通查询接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式: CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定: 2.0.0.2 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
业务开通时传入的请求流水号 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
respCode=000000 成功
|
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
||
checkValue |
加签密文 |
String |
必填 |
加密算法使用: cfca签名 |
|
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据, 内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
memberId |
商户号 |
String(18) |
必填 |
|
reqSerialNum |
原请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一,查询时使用 |
|
yhJsonData |
银行卡支付 |
String |
非必填 |
开通业务数据, 不能同时为空。参
照下面字段说明 例如:”yhJsonData”:
[{“fee02”:”0.5”, “fee03”:”0.5”,
“fee04”:”18”,”fee05”:”0.5”,
“fee06”:”0.5”, “fee07”:”18”}]
“ylJsonData”:[{“fee23”:”0.5”,
“fee24”:”18”,”fee25”:”0.5”,
“mcc”:”6051”}]
“wxJsonData”:
[{“feeRate”:”0.5”,”payScene”:”04”,
payChannelId”:”NS002”,
“mcc”:”112”}]
“alJsonData”:
[{“feeRate”:”1”,”payScene”:”04”,
“payChannelId”:”NS002”,
“mcc”:”2015050700000000”}]
“qrcJsonData”:
[{“fee23”:”0.5”,”fee24”:”18”,”fee25”:”0.5”
|
|
ylJsonData |
银联二维码支付 |
String |
非必填 |
||
wxJsonData |
微信支付 |
ArrayList |
非必填 |
||
alJsonData |
支付宝支付 |
ArrayList |
非必填 |
||
yhJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
指开通银行卡业务需要的参数,包括HUAWEI pay,apple pay等 |
||||
fee02 |
借记卡手续费(%) |
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee05 |
云闪付借记卡
手续费(%)
|
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee04 |
借记卡封顶值 |
String(8) |
必填 |
大于零的数字, 单位元。例如:18 |
|
fee07 |
云闪付借记
卡封顶(元)
|
String(8) |
必填 |
大于零的数字, 单位元。例如: 18 |
|
fee03 |
贷记卡手续费(%) |
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
fee06 |
云闪付贷记卡
手续费(%)
|
String(8) |
必填 |
例如:0.5 表示千分之五的手续费 |
|
ylJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
指开通银联二维码业务 |
||||
fee23 |
借记卡手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
fee24 |
借记卡封顶 |
String(8) |
必填 |
正数,最长保留4位小数,单位元。例如:18 |
|
fee25 |
银联二维码借记
卡手续费率(%)
|
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee28 |
银联二维码借记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
fee29 |
银联二维码贷记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银联二维码经营类目表
|
|
wxJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
payScene |
支付场景 |
String(16) |
必填 |
01 APP支付 (目前不支持)
02 线上公众号支付
03 线上小程序支付
04 线下公众号支付
05 线下微信小程序(使用前需先开通04)
08 教培/医疗机构
09 校园餐饮
10 教育K12
|
feeRate |
手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银微信支付经营类目表 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值:如果在汇付申请了微信渠道号或支付宝渠道号,
在开通微信支付或支付宝支付时,请根据需要传入汇付分配的子渠道号
|
|
subsidyFeeRate |
补贴费率 |
String(4) |
非必填 |
只适用于教培(08)场景使用小数,最长保留4位小数,
例如:0.5-表示千分之五的手续费
|
|
alJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
payScene |
支付场景 |
String(16) |
必填 |
枚举值04 扫码
|
feeRate |
手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
|
mcc |
商户经营类目 |
String(4) |
必填 |
参照银微信支付经营类目表 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值:如果在汇付申请了微信渠道号或支付宝渠道号,
|
|
qrcJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数 |
fee23 |
借记卡手续费(%) |
String(8) |
必填 |
使用小数,例如:0.5 表示千分之五的手续费 |
fee24 |
借记卡封顶 |
String(8) |
必填 |
正数,最长保留4位小数,单位元。例如:18 |
|
fee25 |
银联二维码贷记
卡手续费率(%)
|
String(8) |
必填 |
手续费保留小数点后4位。如:0.5533 |
|
fee38 |
银联二维码借记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
fee39 |
银联二维码贷记
卡二挡手续费
|
String(8) |
非必填 |
标准消费类费率,大于1000元。使用小数,
最长保留4位小数,例如:0.5 表示千分之五的手续费
|
|
mchntType |
商户类型 |
String(4) |
必填 |
商户类型,不是MCC
|
|
merLng |
经度 |
String(20) |
必填 |
||
merLat |
纬度 |
String(20) |
必填 |
商户信息变更接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
salt值加密校验加密算法使用:sha256 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号18位 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
contactEmail |
联系人邮箱 |
String(20) |
必填 |
邮箱格式 |
|
legalName |
法定代表人 |
String(30) |
选填 |
支持少数名族,最大支持15个汉字。 |
|
idType |
法定代表人证件类型 |
String(2) |
选填 |
01-身份证 02-护照 03-港澳台通行证
04-军官证 05-回乡证 06-工商登记号 09-其他
|
|
idNo |
法定代表人证件编号 |
String(16) |
选填 |
身份证号码 |
|
idValidType |
法人证件有效期类型 |
String(1) |
选填 |
1:非长期 2:长期 |
|
idSdate |
法人证件有效
起始时间
|
String(8) |
选填 |
格式: YYYYMMDD 例如: 20190121 |
|
idEdate |
法人证件有效
结束时间
|
String(8) |
选填 |
格式: YYYYMMDD 例如: 20190121 |
|
fee02 |
借记卡手续费(%) |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee03 |
贷记卡费率(%) |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee05 |
云闪付借记卡费率(%) |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee06 |
云闪付贷记卡费率(%) |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee23 |
银联二维码借记
卡手续费率(%)
|
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee25 |
银联二维码借记
卡手续费率(%)
|
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee12 |
支付宝手续费率(%) |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
fee08 |
微信手续费率 |
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
regProvId |
商户注册省份 |
String(16) |
选填 |
1.参考附录1:比如河北省,请填写河北 |
|
regCityId |
商户注册城市 |
String(16) |
选填 |
1.参考附录1:比如唐山市,请填写唐山市 |
|
regAreaId |
商户注册区县 |
String(16) |
选填 |
参考附录1:比如XX区,请填写XX区 |
|
regAddr |
商户注册地址 |
String(16) |
选填 |
填写商户实际的注册详细地址 |
|
contactName |
联系人姓名 |
String(30) |
选填 |
商户联系人姓名。支持少数名族,最大支持15个汉字 |
|
contactTelno |
联系人手机 |
String(11) |
选填 |
手机号格式 |
|
contactId
Type
|
联系人证件类型 |
String(2) |
选填 |
选项:01:身份证、02:护照、04:军官证、
03:港澳台通行证、05:回乡证、
06:工商登记号、09:其他
与联系人证件号码同时为空或同时非空
|
|
contactIdNo |
联系人证件号码 |
String(40) |
选填 |
与联系人证件类型同时为空或同时非空 |
|
contactIdValidType |
联系人证件有效期类型 |
String(1) |
选填 |
1:非长期 2:长期 |
|
contactIdSdate |
联系人证件有效
起始时间
|
String(8) |
选填 |
格式: YYYYMMDD 例如: 20190121 |
|
contactIdEdate |
联系人证件有效
结束时间
|
String(8) |
选填 |
格式: YYYYMMDD 例如: 20190121 |
|
csTel |
客服电话 |
String(20) |
选填 |
支持固话格式,手机格式 |
|
settleTerm |
结算周期 |
String(1) |
选填 |
选项:1代表T+1;2代表D+1 |
|
fee01 |
D+1结算手续费(%) |
String(1) |
选填 |
选择结算周期:D+1时必填 |
|
merchName |
商户注册名称 |
String(60) |
选填 |
商户注册名称, 与输入返回一致 |
|
merchShortName |
商户简称 |
String(32) |
选填 |
简称格式:地区+商户名称+行业,
最大支持16位汉字
|
|
userDefinedName |
商户自定义简称 |
String(32) |
选填 |
如没有特殊需求,可以同商户简称。 |
|
provId |
经营地址所在省 |
String(32) |
选填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如河北省,请填写河北
|
|
cityId |
经营地址所在市 |
String(32) |
选填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如唐山市,请填写唐山市
|
|
areaId |
经营地址所在区县 |
String(32) |
选填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如XX区,请填写XX区
|
|
merchAddr |
商户经营详细地址 |
String(240) |
选填 |
填写商户实际的经营详细地址。
长度说明:80个字符,最多40个汉字
|
|
isCreditCode |
是否三证合一 |
String(1) |
选填 |
选项:0,否;1,是。 |
|
creditCode |
统一社会信用
代码证
|
String(18) |
选填 |
统一社会信用代码证 |
|
regCode |
营业执照编号 |
String(30) |
选填 |
营业执照编号 |
|
orgCode |
组织机构代码证 |
String(10) |
选填 |
非必填,三证合一选择否填写 |
|
licType |
证照有效期 |
String(1) |
选填 |
选项:1, 非长期;2, 长期 |
|
licSdate |
证照开始日期 |
String(8) |
选填 |
日期格式要求:20180115 |
|
licEdate |
证照结束日期 |
String(8) |
选填 |
选择非长期填写, 日期格式要求:20180115 |
|
bgRetUrl |
异步通知地址 |
String(120) |
选填 |
审核结果异步通知推送地址 |
|
pictureIDs |
图片文件ID |
JSON |
选填 |
通过json串儿的方式,
指定图片类型及图片文件编号pictureIDs内容格式: {
archFlph01”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph02”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph03”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph04”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph05”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph06”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph09”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph24”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph25”:”bfc24351-b58c-4261-950f-64571b064f35”,
archFlph26”:”bfc24351-b58c-4261-950f-64571b064f35”}
|
|
pictureIDs |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
archFlph01 |
营业执照 |
String(60) |
非必填 |
||
archFlph02 |
税务登记号 |
String(60) |
非必填 |
||
archFlph03 |
组织机构代码 |
String(60) |
非必填 |
||
archFlph04 |
开户许可证 |
String(60) |
非必填 |
||
archFlph05 |
法人证件正面 |
String(60) |
非必填 |
||
archFlph06 |
法人证件反面 |
String(60) |
非必填 |
||
archFlph07 |
结算人身份证正面 |
String(60) |
非必填 |
||
archFlph08 |
结算人身份证反面 |
String(60) |
非必填 |
||
archFlph09 |
商务协议 |
String(60) |
非必填 |
||
archFlph13 |
联系人证件正面 |
String(60) |
非必填 |
||
archFlph14 |
联系人证件反面 |
String(60) |
非必填 |
||
archFlph24 |
D+1协议照片 |
String(60) |
非必填 |
||
archFlph25 |
结算变更说明表 |
String(60) |
非必填 |
||
archFlph26 |
授权委托书 |
String(60) |
非必填 |
同步返回参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
applyNo |
商户申请单号 |
String(18) |
必填 |
||
agentId |
代理商号 |
String(18) |
必填 |
||
memberId |
商户号 |
String(18) |
必填 |
||
respCode |
返回码 |
String(6) |
必填 |
0001-受理成功 0002-修改成功 0004-修改失败 |
|
respResult |
处理结果 |
String(8) |
必填 |
受理成功、修改成功、修改失败 |
|
respDesc |
返回码描述 |
String(256) |
必填 |
具体错误描述 |
异步返回参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
000000–成功 999999—失败 |
|
respDesc |
返回码描述 |
String(256) |
必填 |
审核失败原因 |
|
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
salt值加密校验加密算法使用:sha256 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
applyNo |
商户申请单号 |
String(18) |
必填 |
||
agentId |
代理商号 |
String(18) |
必填 |
||
memberId |
商户号 |
String(18) |
必填 |
||
返回参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
请求流水号 |
商品订单号 |
String |
必填 |
RECV_ORD_ID_{ applyNo } |
商户入驻结果查询
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据, 内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式:CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定:2.0.0.1 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一, 查询时使用
请使用调用”企业商户基本信息入驻接口”
时传入的”请求流水号”
|
|
merchName |
商户名称 |
String(60) |
必填 |
变长最大60位 |
|
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号 |
|
tellerId |
代理商操作员号 |
String(32) |
必填 |
变长最大32位 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
加密算法使用:cfca签名 |
|
respCode |
返回码 |
String(6) |
必填 |
选项:000000表示成功, 其余表示失败 |
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
||
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据, 内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一, 查询时使用 |
|
memberId |
NSPOS商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
merchName |
商户注册名称 |
String(60) |
非必填 |
商户注册名称 |
|
auth23
URL
|
是否开通银行卡
支付
|
String(1) |
非必填 |
选项:1-成功 0-失败 2 处理中 |
|
auth18 |
是否开通微信支付 |
String(1) |
非必填 |
选项:1-成功 0-失败 2 处理中 |
|
auth19
URL
|
是否开通
支付宝支付
|
String(1) |
非必填 |
选项:1-成功 0-失败 2 处理中 |
|
approveStat |
审核状态 |
String(1) |
必填 |
1-审核通过2-审核拒绝3-待处理4-审核关闭 |
|
reason |
拒绝原因 |
String(256) |
非必填 |
审核拒绝或关闭时返回 |
|
wechatBanke
MerCod
|
微信银行商户 |
String(256) |
非必填 |
||
alipayBank
MerCode
|
支付宝银行商户 |
String(60) |
非必填 |
||
auth20 |
银联二维码
业务开通状态
|
String(1) |
非必填 |
选项:1-成功 0-失败 2 处理中 |
|
auth23Reason |
银行卡业务
开通失败原因
|
String |
非必填 |
||
auth18Reason |
微信业务
开通失败原因
|
String |
非必填 |
||
auth19Reason |
支付宝业务
开通失败原因
|
String |
非必填 |
||
auth20Reason |
支付宝业务
开通失败原因
|
String |
非必填 |
||
ylBankMer
Code
|
银联商户号 |
String |
非必填 |
||
authorizeState |
微信门店授权状态 |
String(1) |
非必填 |
1:授权成功;0:授权失败 |
|
applymentState |
微信实名认证
申请单状态
|
String(64) |
非必填 |
1:编辑中
2:审核中
3:待确认联系信息
4:待账户验证
5:审核通过
6:审核驳回
7:已冻结
8:已作废
9:未申请
|
|
qrCodeData |
联系人确认二维码 |
String(256) |
非必填 |
||
rejectReason |
驳回原因 |
String(1024) |
非必填 |
当申请单状态为“审核驳回”时,
会返回该字段,表示驳回原因
示例值:公司名称与工商局登记不一致
|
商户基本信息修改接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
checkValue |
加签密文 |
String |
必填 |
签名方式:CFCA |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
版本号 |
String(7) |
必填 |
固定:2.0.0.1 |
|
memberId |
NSPOS商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号 |
|
opTellerId |
代理商操作员 |
String(32) |
必填 |
代理商操作员号 |
|
merchName |
商户名称 |
String(64) |
非必填 |
最大支持32个汉字
对公结算商户名称需与结算名称一致
企业商户需与营业执照上名称一致,系统对法人,营业执照,商户名进行称校验
个人商户不支持修改
|
|
merchShortName |
商户简称 |
String(32) |
非必填 |
简称格式:地区+商户名称+行业,
最大支持16位汉字
|
|
provId |
经营地址所在省 |
String(32) |
非必填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如河北省,请填写河北
|
|
cityId |
经营地址所在市 |
String(32) |
非必填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如唐山市,请填写唐山市
|
|
areaId |
经营地址所在区县 |
String(32) |
非必填 |
参照《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如XX区,请填写XX区
|
|
merchAddr |
商户经营详细地址 |
String(240) |
非必填 |
填写商户实际的经营详细地址。
长度说明:80个字符,最多40个汉字
|
|
contactName |
商户联系人 |
String(30) |
非必填 |
商户联系人姓名。支持少数名族,
联系人信息联动修改
|
|
contactId
Type
|
联系人证件类型 |
String(2) |
非必填 |
选项:01:身份证、02:护照、04:军官证、
03:港澳台通行证、05:回乡证、
06:工商登记号、09:其他
|
|
contactIdNo |
联系人证件号码 |
String(40) |
非必填 |
联系人信息联动修改 |
|
contactId
ValidType
|
联系人证件有效期 |
String(1) |
非必填 |
选项:1,非长期;2,长期 |
|
contactId
Sdate
|
联系人证件有效期
开始日期
|
String(8) |
非必填 |
日期格式要求:20180115
联系人信息联动修改
|
|
contactId
Edate
|
联系人证件有效期
结束日期
|
String(8) |
非必填 |
日期格式要求:20180115
联系人信息联动修改
|
|
contactTelno |
联系人手机 |
String(11) |
非必填 |
手机号格式 |
|
bankPhone |
银行卡预留手机号 |
String(11) |
非必填 |
手机号格式 |
|
contactEmail |
联系人邮箱 |
String(40) |
非必填 |
邮箱格式 |
|
csTel |
客服电话 |
String(20) |
非必填 |
支持固话格式,手机格式 |
|
isPrivate |
结算账户类型 |
String(1) |
非必填 |
选项:0.对公 1.对私 |
|
bankActName |
结算账户名 |
String(30) |
非必填 |
结算账户名称 |
|
bankActId |
结算账号 |
String(30) |
非必填 |
结账账号 |
|
bankProvId |
银行所在省 |
String(32) |
非必填 |
参考《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如河北省,请填写河北
|
|
bankCityId |
银行所在市 |
String(32) |
非必填 |
参考《智能收单商户入驻申请接口文档-
附录》中的《附录1 省份地区对照表》
比如唐山市,请填写唐山市
|
|
bankName |
银行名称 |
String(32) |
非必填 |
参考《智能收单商户入驻申请接口文档-
附录》中的
附录2 区域银行支行对照表》
|
|
bankUnion
Code
|
银行联行号 |
String(12) |
非必填 |
结算账户名联动修改 |
|
subBankName |
支行名称 |
String(30) |
非必填 |
结算账户名联动修改 |
|
fee01 |
D+1结算手续费(%) |
String(1) |
条件必填 |
商户开通D+1时可填写 |
|
d1FeeOuterAuth |
D+1结算外扣开关 |
String(1) |
条件必填 |
商户开通D+1外扣时可填写
1:开通
0:关闭
|
|
fee01MerId |
D+1结算外扣账户 |
String(18) |
条件必填 |
商户开通D+1和外扣开关打开时可填写 |
|
auth104 |
D0开关 |
String(1) |
非必填 |
1:开通
0:关闭
|
|
fee28 |
D0结算手续费(%) |
String(10) |
条件必填 |
选择结算业务为01时必填(%) |
|
outFlagD0 |
D0手续费外扣开关 |
String(1) |
非必填 |
1:开通
0:关闭
|
|
outFeeMemD0 |
D0手续费外扣账户 |
String(18) |
条件必填 |
商户开通D0手续费外扣时必填
填写上级代理商或渠道商会员号
|
|
settleRemark |
结算摘要 |
String(200) |
非必填 |
默认为空如果需要自定义结算打款备注
请使用此字段传入,字段类型为字符串
|
|
licType |
证照有效期 |
String(1) |
必填 |
选项:1,非长期;2,长期 |
|
licSdate |
证照开始日期 |
String(8) |
必填 |
日期格式要求:20180115 |
|
licEdate |
证照结束日期 |
String(8) |
条件必填 |
选择非长期填写日期格式要求20180115 |
|
orgCode |
组织机构代码证 |
String(10) |
条件必填 |
三证合一选择否填写 |
|
legalName |
法人 |
String(20) |
条件必填 |
企业用户必填,法人姓名。
支持少数名族,最大支持20个汉字。
|
|
idType |
法人证件类型 |
String(2) |
条件必填 |
企业用户必填,选项:01:身份证02:护照
04:军官证03:港澳台通行证05:回乡证
06:工商登记号09:其他
|
|
idNo |
法人证件号码 |
String(40) |
条件必填 |
企业用户必填 |
|
idValidType |
法人证件有效期 |
String(1) |
条件必填 |
企业用户必填,选项:1非长期;2长期 |
|
idSdate |
法人证件有效期
开始日期
|
String(8) |
条件必填 |
企业用户必填日期格式要求20180115 |
|
idEdate |
法人证件有效期
证件结束日期
|
String(8) |
条件必填 |
选择非长期填写日期格式要求20180115 |
|
accountId
Type
|
持卡人证件类型 |
String(2) |
条件必填 |
对私结算时必填 选项:01:身份证
02:护照、04:军官证03:港澳台通行证
05:回乡证06:工商登记号09:其他
|
|
accountIdNo |
持卡人证件号码 |
String(40) |
条件必填 |
对私结算时必填,持卡人证件号码 |
|
accountId
ValidType
|
证件有效期 |
String(1) |
条件必填 |
对私结算时必填 选项1:非长期;2:长期
持卡人信息联动修改
|
|
accountId
Sdate
|
证件有效期
开始日期
|
String(8) |
条件必填 |
对私结算时必填日期格式要求20180115
持卡人信息联动修改
|
|
account
IdEdate
|
证件有效期结束日期 |
String(8) |
条件必填 |
选择非长期填写日期格式要求20180115
持卡人信息联动修改
|
|
archFlph01 |
营业执照 |
String(60) |
非必填 |
||
archFlph04 |
开户许可证 |
String(60) |
非必填 |
||
archFlph05 |
法人证件正面 |
String(60) |
非必填 |
||
archFlph06 |
法人证件反面 |
String(60) |
非必填 |
||
archFlph07 |
结算人身份证正面 |
String(60) |
非必填 |
||
archFlph08 |
结算人身份证反面 |
String(60) |
非必填 |
||
archFlph13 |
联系人证件正面 |
String(60) |
非必填 |
||
archFlph14 |
联系人证件反面 |
String(60) |
非必填 |
||
archFlph18 |
结算卡正面 |
String(60) |
非必填 |
||
archFlph19 |
结算卡反面 |
String(60) |
非必填 |
||
archFlph25 |
结算变更说明 |
String(60) |
非必填 |
非必填 |
|
archFlph26 |
授权委托书 |
String(60) |
非必填 |
非必填 |
|
archFlph27 |
结婚证照片原件 |
String(60) |
非必填 |
非必填 |
|
archFlph28 |
户口本照片原件 |
String(60) |
非必填 |
非必填 |
|
archFlph29 |
工商信息网
天眼信息网截图
|
String(60) |
非必填 |
非必填 |
|
archFlph30 |
水电煤账单 |
String(60) |
非必填 |
非必填 |
|
archFlph31 |
租赁合同 |
String(60) |
非必填 |
非必填 |
|
archFlph40 |
业务办理授权函 |
String(60) |
非必填 |
||
reqSerialNum |
请求流水号 |
String(120) |
非必填 |
由接入方生成且保证唯一,查询时会用到 |
|
bgRetUrl |
异步通知地址 |
String(120) |
非必填 |
审核结果异步通知推送地址 |
|
modifyNoticeUrl |
通道修改状态异步通知url |
String(120) |
非必填 |
||
wxSubsidyFeeRate |
微信教培补贴费率 |
String(10) |
非必填 |
只有开通教培业务才可以修改 |
|
fee33 |
微信线下小程序支付费率 |
String(10) |
非必填 |
||
fee34 |
微信线上app支付费率 |
String(10) |
非必填 |
||
fee35 |
微信线上公众号支付费率 |
String(10) |
非必填 |
||
fee36 |
微信线上小程序支付费率 |
String(10) |
非必填 |
||
openLicenceNo |
开户许可核准号 |
String(32) |
非必填 |
||
legalAddress |
法人居住地址 |
String(400) |
非必填 |
企业商户进行微信实名则必填
请按照证件上住址填写,若证件上无
如广东省深圳市南山区xx路xx号xx室
|
|
aliClsCode |
支付宝行业分类 |
String(4) |
非必填 |
||
owner |
法人是否为受益人 |
String(1) |
非必填 |
1-是
0-否
|
|
uboJsonData |
受益人信息 |
JSONArray |
非必填 |
法人是否为受益人选择否则必填,
最多可填写5个,见下方字段详解
修改将覆盖之前所有的受益人,请全量填写
|
|
uboJsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
uboName |
受益人姓名 |
String(20) |
必填 |
||
uboIdType |
受益人证件类型 |
String(2) |
必填 |
01:身份证 02:护照 04:军官证 03:港澳台通行证
05:回乡证 06:工商登记号 09:其他
|
|
uboIdNo |
受益人证件号码 |
String(40) |
必填 |
||
uboAddress |
受益人地址 |
String(400) |
必填 |
请按照证件上住址填写,
若证件上无住址则按照实际住址填写
如广东省深圳市南山区xx路xx号xx室
|
|
uboIdStart |
受益人证件开始日期 |
String(8) |
必填 |
示例值:19840728
|
|
uboIdValidType |
受益人证件有效期类型 |
String(1) |
必填 |
1-非长期 2-长期
|
|
uboIdEnd |
受益人证件结束日期 |
String(8) |
非必填 |
受益人证件有效期类型选择1-非长期时必填,示例值:20300822
|
|
uboIdCopy |
受益人证件正面 |
String(40) |
非必填 |
需要微信实名认证请填写
|
|
uboIdBack |
受益人证件反面 |
String(40) |
非必填 |
需要微信实名认证请填写
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
00001表示受理成功,00002表示修改成功,其余为失败 |
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
||
checkValue |
加签密文 |
String |
必填 |
加密算法使用:cfca签名 |
|
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据,内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
NSPOS商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
agentId |
代理商号 |
String(18) |
必填 |
||
applyNo |
商户申请单号 |
String(18) |
必填 |
||
reqSerialNum |
原请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一,查询时使用 |
异步通知
基本信息修改接口异步通知
发布路径
bgRetUrl(接口上送时填写的异步通知地址)
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
选项:000000表示成功,其余表示失败 |
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
开通失败,需要告知开通失败 |
|
checkValue |
加签密文 |
String |
必填 |
加密算法使用:cfca签名 |
|
jsonData |
Json字符串 |
jsonData |
非必填 |
jsonData数据,内容见下方描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
reqSerialNum |
原请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一,查询时使用 |
|
memberId |
NSPOS商户号 |
String(18) |
非必填 |
固定18位 ,汇付分配的商户号 |
|
agentId |
代理商号 |
String(18) |
必填 |
||
applyNo |
商户申请单号 |
String(18) |
必填 |
||
商户应答参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
reqSerialNum |
请求流水号 |
String |
必填 |
RECV_ORD_ID_{ reqSerialNum } |
商户信息查询接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
商户号 |
String(18) |
条件必填 |
memberId与reqSerialNum必填一项 |
|
reqSerialNum |
请求流水号 |
String(120) |
条件必填 |
memberId与reqSerialNum必填一项 |
|
agentId |
代理商会员号 |
String(18) |
必填 |
代理商会员号18位 |
|
opTellerId |
代理商操作员 |
String(32) |
必填 |
代理商操作员号 |
|
apiVersion |
版本号 |
String(7) |
必填 |
2.0.0.1 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
非必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
非必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
非必填 |
000000表示成功,其余表示失败 |
|
respResp |
返回描述 |
String(256) |
非必填 |
返回描述 |
|
jsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
merchName |
商户注册名称 |
String(60) |
非必填 |
商户注册名称 |
|
merchShort
Name
|
商户简称 |
String(32) |
非必填 |
简称格式:地区+商户名称+行业 |
|
provName |
经营地址所在省 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1省份
地区对照表》比如河北省请
填写河北
|
|
cityName |
经营地址所在市 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1 省份
地区对照表》比如唐山市,
请填写唐山市
|
|
areaName |
经营地址所在区县 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1
省份地区对照表》比如XX区,
请填写XX区
|
|
merchAddr |
商户经营详细地址 |
String(240) |
非必填 |
填写商户实际的经营详细地址 |
|
business
Shours
|
营业开始时间 |
String(5) |
非必填 |
格式要求:09:00 |
|
business
Ehours
|
营业结束时间 |
String(5) |
非必填 |
格式要求:22:00 |
|
licType |
证照有效期类型 |
String(1) |
非必填 |
选项:1,非长期;2,长期 |
|
licSdate |
证照开始日期 |
String(8) |
非必填 |
日期格式要求:20180115 |
|
licEdate |
证照结束日期 |
String(8) |
非必填 |
日期格式要求:20180115 |
|
tellerId |
管理员账号 |
String(32) |
非必填 |
使用手机号或联系人姓名拼音+生日 |
|
agentId |
代理商会员号 |
String(18) |
非必填 |
代理商会员号 |
|
opTellerId |
代理商操作员号 |
String(32) |
非必填 |
代理商操作员号 |
|
contactName |
商户联系人 |
String(30) |
非必填 |
商户联系人姓名,支持少数名族 |
|
contactId
Type
|
联系人证件类型 |
String(2) |
非必填 |
01:身份证02:护照03:港澳台
通行证04军官证05回乡证06工
商登记号09其他
|
|
contactIdNo |
联系人证件号码 |
String(40) |
非必填 |
联系人证件号码 |
|
contactIdValid
Type
|
联系人证件有效期 |
String(1) |
非必填 |
选项:1,非长期;2,长期 |
|
contactId
Sdate
|
联系人证件有效期
开始日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
contactId
Edate
|
联系人证件有效期
结束日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
contactTelno |
联系人手机 |
String(11) |
非必填 |
手机号格式 |
|
contactEmail |
联系人邮箱 |
String(40) |
非必填 |
邮箱格式 |
|
csTel |
客服电话 |
String(20) |
非必填 |
支持固话格式,手机格式 |
|
isPrivate |
结算账户类型 |
String(1) |
非必填 |
选项:0.对公 1.对私 |
|
settleTerm |
结算周期 |
String(1) |
非必填 |
选项:1代表T+1;2代表D+1 |
|
settleBusi |
结算业务 |
String(8) |
非必填 |
01-D0/02-延迟入账/03-D1
手续费外扣以英文逗号隔开,
01和02不能同时开通
|
|
fee104 |
D0手续费 |
String(10) |
非必填 |
例如0.1(%) |
|
fee01MerId |
D1外扣账户 |
String(18) |
非必填 |
D1外扣账户 |
|
bankActName |
结算账户名 |
String(60) |
非必填 |
结算账户名 |
|
bankActId |
结算账号 |
String(32) |
非必填 |
结账账号 |
|
bankProvId |
银行所在省 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1省份
地区对照表》比如河北省请
填写河北
|
|
bankCityId |
银行所在市 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1
省份地区对照表》比如唐山市,
请填写唐山市
|
|
bankAreaName |
银行所在区县 |
String(32) |
非必填 |
参照《智能收单商户入驻申请
接口文档-附录》中的《附录1
省份地区对照表》比如XX区,
请填写XX区
|
|
bankName |
银行名称 |
String(32) |
非必填 |
参考《智能收单商户入驻申请
接口文档-附录》中的附录2
区域银行支行对照表
|
|
bankUnion
Code
|
银行联行号 |
String(12) |
非必填 |
银行联行号 |
|
subBankName |
支行名称 |
String(30) |
非必填 |
支行名称 |
|
settleRemark |
结算摘要 |
String(200) |
非必填 |
自定义结算打款备注 |
|
isCreditCode |
是否三证合一 |
String(1) |
非必填 |
选项:0,否;1,是。 |
|
creditCode |
统一社会信用
代码证
|
String(18) |
非必填 |
统一社会信用代码证 |
|
regCode |
营业执照编号 |
String(30) |
非必填 |
营业执照编号 |
|
orgCode |
组织机构代码证 |
String(10) |
非必填 |
非必填,三证合一选择否填写 |
|
legalName |
法人 |
String(20) |
非必填 |
支持少数名族,最大支持20个汉字。 |
|
idType |
法人证件类型 |
String(2) |
非必填 |
01:身份证02:护照03:港澳台
通行证04:军官证05回乡证06工商
登记号09其他
|
|
idNo |
法人证件号码 |
String(40) |
非必填 |
法人证件号码 |
|
idValidType |
法人证件有效期 |
String(1) |
非必填 |
选项:1,非长期;2,长期 |
|
idSdate |
法人证件有效期
开始日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
idEdate |
法人证件有效期
结束日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
retUrl |
异步通知地址 |
String(120) |
非必填 |
异步通知地址进行消息推送 |
|
accountId
Type
|
持卡人证件类型 |
String(2) |
非必填 |
01:身份证02:护照03:港澳台
通行证04:军官证05回乡证06
工商登记号09其他
|
|
accountIdNo |
持卡人证件号码 |
String(40) |
非必填 |
持卡人证件号码 |
|
accountIdVa
lidType
|
证件有效期 |
String(1) |
非必填 |
选项:1,非长期;2,长期 |
|
accountId
Sdate
|
证件有效期
开始日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
accountId
Edate
|
证件有效期
结束日期
|
String(8) |
非必填 |
日期格式要求:20180115 |
|
reqSerialNum |
请求流水号 |
String(120) |
非必填 |
请求流水号 |
|
yhJsonData |
银行卡支付 |
Json |
非必填 |
开通业务数据,不能同时为空。
具体参数参照下面字段说明
|
|
ylJsonData |
银联二维码支付 |
Json |
非必填 |
||
wxJsonData |
微信支付 |
Json |
非必填 |
||
alJsonData |
支付宝支付 |
Json |
非必填 |
||
isOutFee |
是否开通交易
手续费外扣
|
String(1) |
非必填 |
是否开通交易手续费外扣 |
|
feeMemberId |
交易手续费
外扣账户
|
String(18) |
非必填 |
交易手续费外扣账户 |
|
regProvName |
注册地址所在省 |
String(32) |
非必填 |
省编名称,例如:安徽 |
|
regCityName |
注册地址所在市 |
String(32) |
非必填 |
市编名称,例如:合肥市 |
|
regAreaName |
注册地址所在区县 |
String(32) |
非必填 |
区/县编名称,例如:政务区 |
|
regAddr |
商户注册详细地址 |
String(80) |
非必填 |
商户注册详细地址 |
|
basecontractNum |
合同编号 |
String(20) |
非必填 |
合同编号 |
|
signName |
签约业务经理 |
String(32) |
非必填 |
例如:张三 |
|
signDate |
签约日期 |
String(8) |
非必填 |
YYYYMMDD 例如:20190121 |
|
signSdate |
合同有效期
开始日期
|
String(8) |
非必填 |
YYYYMMDD 例如:20190121 |
|
signEdate |
合同有效期
结束日期
|
String(8) |
非必填 |
YYYYMMDD 例如:20190121 |
|
wechatPub
NumAppid
|
公众号支付
Appid
|
String(60) |
非必填 |
多个以”;”分隔 |
|
wechatPub
NumAuth
|
公众号支付
授权目录
|
String(60) |
非必填 |
多个以”;”分隔 |
|
wechatPubNum |
关注公众号 |
String(60) |
非必填 |
关注公众号 |
|
auth306 |
是否开通微信
小程序支付
|
String(1) |
非必填 |
是否开通微信小程序支付 |
|
fee411 |
小程序支付
手续费
|
String(10) |
非必填 |
小程序支付手续费 |
|
joinType |
参加活动类型 |
String(2) |
非必填 |
都开通以英文”,”分隔 |
|
wxAppid |
APP支付app Id |
String |
非必填 |
||
memberId |
商户ID |
String(18) |
非必填 |
商户会员号 |
|
yhJsonData
|
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数
|
chargeCate
Code
|
银行卡手续费类型 |
String(2) |
非必填 |
默认为03-标准类,01-减免类
02-优惠类03-标准类
|
fee02 |
借记卡手续费(%) |
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
|
fee05 |
云闪付借记卡
手续费(%)
|
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
|
fee04 |
借记卡封顶值 |
String(8) |
非必填 |
大于零的数字,单位元。例如:18 |
|
fee07 |
云闪付借记卡
封顶(元)
|
String(8) |
非必填 |
大于零的数字,单位元。例如:18 |
|
fee03 |
贷记卡手续费(%) |
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
|
fee06 |
云闪付贷记卡
手续费(%)
|
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
|
mcc |
商户经营类目 |
String(4) |
非必填 |
参照银联二维码经营类目表 |
|
unionRegCode |
银联现场注册码 |
String(20) |
非必填 |
银联现场注册码 |
|
ylJsonData
|
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数
|
fee23 |
借记卡手续费(%) |
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
fee24 |
借记卡封顶 |
String(8) |
非必填 |
大于零的数字,单位元。例如:18 |
|
fee25 |
银联二维码借记
卡手续费率(%)
|
String(6) |
选填 |
手续费保留小数点后4位。如:0.5533 |
|
mcc |
商户经营类目 |
String(4) |
非必填 |
参照银联二维码经营类目表 |
|
wxJsonData
|
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数
|
feeRate |
手续费(%) |
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
mcc |
商户经营类目 |
String(4) |
非必填 |
参照微信支付经营类目表 |
|
alJsonData
|
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
组成参数
|
feeRate |
手续费(%) |
String(8) |
非必填 |
例如:0.5 表示千分之五的手续费 |
mcc |
商户经营类目 |
String(4) |
非必填 |
参照阿里支付经营类目表 |
商户图片上传接口
发布路径
https://nsposf.cloudpnr.com/nsposfweb/webB9002/uploadWebMerPic
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
picture |
图片 |
二进制流 |
必填 |
图片。上传照片的文件名以及图片的内容
(在发送请求时,图片内容以二进制数据流
的形式发送,见下面的请求示例)。图片名字
不要超过30个字符。
|
|
checkValue |
加签密文 |
String |
必填 |
salt值加密校验,盐值使用:chinapnr,
加密算法使用:sha256
|
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
agentId |
代理商号 |
String(18) |
必填 |
代理商会员号 |
memberId |
商户号 |
String(18) |
必填 |
在调用《结算信息修改接口》或者
《商户信息修改接口》时,如若需要
通过该接口上传图片则该字段必填
|
|
photoType |
图片类型 |
String(2) |
必填 |
可选值:
01:营业执照图片
02:税务登记证
03:组织机构代码证
04:开户许可证
05:法人身份证正面
06:法人身份证反面
07:结算人身份证正面
08:结算人身份证反面
09:商务协议
10:公司照片一
11:公司照片二
11:公司照片三
13:联系人身份证正面
14:联系人身份证反面
15:店铺门头照片
16:店铺收银台照片
17:店内照片
18:结算卡正面
19:结算卡反面
20:主流餐饮平台入驻照片
24: D+1协议照片
25:结算变更说明表
26:授权委托书
27:结婚证照片原件
28:户口本照片原件
29:工商信息网/天眼信息网截图
30:水电煤账单
31:租赁合同
32:单位证明函
34: 机构资质证明照片
35: 门店租赁相关证明照片
36: 办学许可证
37: 合作资质证明照片
38: 优惠费率承诺函图片
39:结算人手持授权委托书
40:业务办理授权函
41: 受益人证件正面
42: 受益人证件反面
43: 医疗执业许可证图片
44:分账证明材料
|
|
reqSerialNum |
请求流水号 |
String(120) |
非必填 |
由合作方提供唯一的ID,此字段平台不做任何处理,
在返回结果时会原值返回给合作方。
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
respCode |
返回码 |
String(6) |
必填 |
0000表示成功,9000表示失败; |
|
respDesc |
返回文字说明 |
String(256) |
非必填 |
返回文字说明 |
|
checkValue |
加签密文 |
String |
必填 |
对jsonData 用salt值加密校验 加密算法使用:sha256 |
|
jsonData |
Json字符串 |
json |
必填 |
jsonData数据,内容见下方描述 |
|
jsonData |
reqSerialNum |
请求流水号 |
String(120) |
非必填 |
由合作方提供唯一的ID,此字段平台不做
任何处理,原值返回给合作方。
|
pictureID |
图片文件ID |
String |
非必填 |
商户接口进件时,合作方须将图片文件ID一并上送。 |
提示
1、测试环境url : http://139.224.37.244:8084/2、生产环境url : https://nsposf.cloudpnr.com/3、接口调用方式为https post4、编码使用utf-85、checkValue对jsonData的内容及盐值进行加签,保留json的格式内容6、如果json请求串中值为null,则json串格式应为{“test”: “”}7、提交成功后,平台将返回图片文件ID。合作方须在商户进件接口上将图片文件ID一并上送。8、图片大小限制在5M以内。建议1M大小最好。9、图片上传请求有并发数量限制,须大量请求请提前上传图片以便接口进件时使用。10、每次请求,仅可上传一张图片。在前次上传图片请求处理没有结束之前,再次发送请求会被拒绝。
样例
请求:
public String upload(String localFile,String urlStr){
// localFile = "D:/temp/363f9a31c170c7e7933.jpg";
// urlStr = " https://nsposf.cloudpnr.com/nsposfweb/webB9002/uploadWebMerPic";
File file = new File(localFile);
CloseableHttpClient httpclient = HttpClients.createDefault();
CloseableHttpResponse response = null;
String result = null;
try {
HttpPost httpPost = new HttpPost(urlStr);
httpPost.setHeader("charset", "utf-8");
MultipartEntityBuilder mEntityBuilder = MultipartEntityBuilder.create();
mEntityBuilder.addBinaryBody("picture", file);
ContentType contentType = ContentType.create("text/plain",Charset.forName("UTF-8"));
Map<String, Object> map = new HashMap<String, Object>();
map.put("agentId", "1000000000000002");
map.put("photoType", "01");
map.put("reqSerialNum", "1234567890abc");
String returnStr = JSON.toJSONString(map);
mEntityBuilder.addTextBody("jsonData", returnStr,contentType);
mEntityBuilder.addTextBody("checkValue", ShaUtil.encode(returnStr, "chinapnr", "UTF-8"),contentType);
httpPost.setEntity(mEntityBuilder.build());
response = httpclient.execute(httpPost);
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode == HttpStatus.SC_OK) {
HttpEntity resEntity = response.getEntity();
result =EntityUtils.toString(resEntity);
// 消耗掉response
EntityUtils.consume(resEntity);
}
} catch (ParseException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
HttpClientUtils.closeQuietly(httpclient);
HttpClientUtils.closeQuietly(response);
}
return result; // 返回json串
}
微信风控接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
由接入方生成且保证唯一 |
|
agentId |
代理商会员号 |
String(18) |
必填 |
代理商会员号18位 |
|
fullName |
身份证所有者姓名 |
String(20) |
必填 |
身份证号所有者姓名 |
|
idNumber |
身份证号 |
String(18) |
必填 |
身份证号 |
|
acctNo |
结算的银行卡号 |
String(30) |
必填 |
结算的银行卡号 |
|
acctName |
结算银行卡帐号名 |
String(20) |
必填 |
结算银行卡帐号名 |
|
acctBank |
结算银行 |
String(60) |
必填 |
结算银行 |
|
licenseNo |
营业执照编号 |
String(60) |
非必填 |
营业执照编号。提供营业执照信息时,
必须提供营业执照编号、公司名称
|
|
companyName |
公司名称 |
String(60) |
条件必填 |
公司名称,填写营业执照编号时必填 |
|
companyAdd
ress
|
门店地址 |
String(80) |
非必填 |
门店地址。注:查询有门店信息时,
必须提供门店地址、门店经度、门店纬度
|
|
companyLon
gitude
|
门店经度 |
String(20) |
条件必填 |
填写门店地址时必填,例如:22.5461478801 |
|
companyLa
titude
|
门店纬度 |
String(20) |
条件必填 |
填写门店地址时必填,例如:113.941051963 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
000093 请求参数非法
000099 请求超时
000306代理商不存在
000105代理商状态异常
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
riskLevel |
风险等级 |
String(1) |
必填 |
U:未知风险
N:一般
M:中风险
H:高风险
L:低风险
F:禁入
E:风险核查异常
|
|
riskLevelDesc |
风险等级描述 |
String(128) |
必填 |
风险等级描述 |
|
orderId |
流水号 |
String(32) |
必填 |
智汇管家生成系统流水号 |
|
reqSerialNum |
请求流水号 |
String(120) |
必填 |
调用方请求唯一流水号,原样返回 |
微信实名认证重认证接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值,与业务开通时保持一致 |
|
payScene |
支付场景 |
String(16) |
必填 |
枚举值:
01:普通线下
02:智慧餐饮
03:校园零费率
04:私立校园零费率
05:线上
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
applymentId |
申请单编号 |
String(128) |
非必填 |
微信支付分配的申请单号,申请成功时返回 |
微信实名认证查询接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值,与业务开通时保持一致 |
|
payScene |
支付场景 |
String(16) |
必填 |
枚举值:
01:普通线下
02:智慧餐饮
03:校园零费率
04:私立校园零费率
05:线上
|
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
registerList |
查询列表 |
Json数组 |
非必填 |
||
registerList |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
applymentStat |
微信实名认证
申请单状态
|
String(64) |
非必填 |
1:编辑中
2:审核中
3:待确认联系信息
4:待账户验证
5:审核通过
6:审核驳回
7:已冻结
8:已作废
9:未申请
|
|
authorizeStat |
授权状态 |
非必填 |
1:授权成功;0:授权失败 |
||
payScene |
支付场景 |
String(16) |
非必填 |
||
qrcodeData |
授权二维码 |
String |
非必填 |
||
rejectReason |
驳回原因 |
String |
非必填 |
||
smid |
银行商户号 |
String(60) |
非必填 |
支付宝/微信/银联商户号 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
支付宝实名认证申请接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
payChannelId |
子渠道号 |
String(50) |
非必填 |
入驻多渠道时传值,与业务开通时保持一致 |
|
certType |
证书类型 |
String(32) |
非必填 |
企业商户,商户类型为政府机关、事业单位、其他组织时必填
统一社会信用代码证书(UNIT_SOCIAL_CREDIT)
慈善组织公开募捐资格证书(CHARITY_ORG_SOLICIT)
社会团体法人登记证书(SOCIAL_ORG_LEGAL)
民办非企业单位登记证书(CIVIL_UN_ENT)
基金会法人登记证书(FOUNDATION_LEGAL_PERSON)
农民专业合作社法人营业执照(FARMERS_COOPERATE)
宗教活动场所登记证(RELIGION_PLACES)
其他证书/批文/证明(OTHER_REG_CERT)
|
|
merchantType |
个人商户类型 |
String(32) |
非必填 |
个人商户必填,枚举值
门店场所(STORE)
流动经营(STALL)
|
|
merOrdId |
商户请求号 |
String(64) |
必填 |
同一商户下保证唯一性 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
orderNo |
申请单号 |
String(64) |
非必填 |
||
orderStatus |
意愿申请单状态 |
String(128) |
非必填 |
审核中(AUDITING)
待联系人确认(CONTACT_CONFIRM)
待法人确认(LEGAL_CONFIRM)
审核通过(AUDIT_PASS)
审核失败(AUDIT_REJECT)
已冻结(AUDIT_FREEZE)
已撤回(CANCELED)
|
支付宝实名认证申请查询接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
merOrdId |
商户请求号 |
String(64) |
非必填 |
实名认证申请时的订单号merOrdId和orderNo 不能同时为空 |
|
orderNo |
申请单号 |
String(64) |
非必填 |
提交申请时返回的申请单号merOrdId和orderNo 不能同时为空 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
orderNo |
申请单号 |
string(64) |
非必填 |
||
orderStatus |
意愿申请单状态 |
String(64) |
非必填 |
审核中(AUDITING)
待联系人确认(CONTACT_CONFIRM)
待法人确认(LEGAL_CONFIRM)
审核通过(AUDIT_PASS)
审核失败(AUDIT_REJECT)
已冻结(AUDIT_FREEZE)
已撤回(CANCELED)
|
|
qrCode |
实名认证二维码 |
String(128) |
非必填 |
商家认证小程序二维码图片链接
申请单状态处于审核成功、审核中、已冻结时返回
商户使用支付宝APP扫码后完成后续确认动作
|
|
verifyList |
订单审核失败时
的原因描述列表
|
JSONArray |
非必填 |
||
verifyList |
failParam |
审核失败字段 |
String(64) |
非必填 |
|
failReason |
描述申请单审核失败原因 |
String(128) |
非必填 |
证照编号对应的企业名称、法人名称与录入信息不一致
|
支付宝实名认证申请撤销接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
merOrdId |
商户请求号 |
String(64) |
非必填 |
实名认证申请时的订单号merOrdId和orderNo 不能同时为空 |
|
orderNo |
申请单号 |
String(64) |
非必填 |
提交申请时返回的申请单号merOrdId和orderNo 不能同时为空 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
businessStat |
撤销状态 |
string(1) |
非必填 |
F-撤销失败,S-撤销成功 |
|
businessMsg |
返回信息 |
String(128) |
非必填 |
支付宝实名商户授权状态查询接口
发布路径
输入参数
输入参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
apiVersion |
接口版本号 |
String(7) |
必填 |
2.0.0.1 |
|
memberId |
商户号 |
String(18) |
必填 |
固定18位 ,汇付分配的商户号 |
|
payChannelId |
入驻渠道号 |
String(32) |
非必填 |
输出参数
输出参数 |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkValue |
加签密文 |
String |
必填 |
Cfca方式验签 |
|
jsonData |
json |
json |
必填 |
jsonData数据,内容见下方描述 |
|
respCode |
返回码 |
String(6) |
必填 |
000000成功,其他均为失败 |
|
respDesc |
返回描述 |
String(256) |
非必填 |
返回描述
具体返回描述信息,如:请求参数不规范
|
|
JsonData |
参数代码 |
参数名称 |
数据类型 |
是否必填 |
参数说明 |
checkResult |
确认状态 |
String(64) |
非必填 |
已确认(AUTHORIZED)
未确认(UNAUTHORIZED)
已销户(CLOSED)
smid不存在(SMID_NOT_EXIST)
说明:商户在银、网联生成的支付宝子商户不一样,该字段是对于银、网联
不同商户号授权状态的交集,比如银联已授权、网联未授权,那么结果就为未授权
具体实名认证状态请参照checkResultList字段
|
|
checkResultList |
子商户号授权状态集合 |
JSONArray |
非必填 |
该字段包含商户在银、网联生成的支付宝子商户各自的授权状态,子域如下
|
|
checkResul
tList
|
bankMerCode |
支付宝子商户号 |
String(32) |
必填 |
|
channelType |
通道类型 |
String(1) |
必填 |
U-银联 N-网联
|
|
checkResult |
授权确认状态 |
String(64) |
必填 |
已确认(AUTHORIZED)
未确认(UNAUTHORIZED)
已销户(CLOSED)
smid不存在(SMID_NOT_EXIST)
|
错误码
错误码
常见错误码描述,如还未解决问题请及时联系专业技术支持人员。错误码 描述 错误码 描述 错误码 描述 000000 操作成功 000098 请求参数非法 000267 接口获取状态与订单状态不符 000093 请求参数不规范 000097 数据库异常 000268 二维码反向交易超时 000094 重复交易 000234 订单生成失败 000272 订单查询,未查询到记录 000095 验签失败 000236 PA入账失败 000273 支付通道类型不为微信或者支付宝 000100 业务系统已关闭 000238 对象属性复制异常 000277 无此交易类型 000107 业务系统不存在 000240 冻结账务对象不存在,分账串解析为空 000278 无此交易记录 000202 订单已存在 000241 订单被风控拒绝,风控未通过 000279 退货失败,该笔订单非退货交易 000203 原订单不存在 000242 风控系统调用异常 000197 控台系统异常,网络繁忙 000204 撤销金额与原订单金额不一致 000243 撤销或退货失败,PA冻结超时 000281 交易处理中 000205 撤销日期与原订单日期不一致 000244 不存在该账务类型 000099 网络繁忙,请稍后再试 000206 撤销失败,账务状态异常 000245 分账串异常 000219 订单校验失败 000207 撤销失败,PA冻结失败 000250 退货失败,PA退款失败 000220 签名上送失败,订单未完成支付 000208 撤销失败,通道失败 000256 退货失败,PA冻结超时 000221 签名上传失败,已上传 000209 撤销失败,原订单未完成 000255 确认交易失败,账务状态异常 000213 退货失败,超出退货期限 000210 退货失败,原订单未完成 000257 确认交易失败,原订单未成功 000214 退货失败,PA冻结失败 000211 退货失败,账务状态异常 000258 确认交易失败,确认金额与原交易金额不一致 000215 退货失败,通道失败 000212 退货失败,超出可退货金额 000260 消费撤销发通道扣款超时 000261 消费退货发通道扣款超时 000199 二维码交易处理中 000198 二维码交易失败
SDK与DEMO
说明
SDK和DEMO作为参考或示例,请服务商在使用过程中,要专业技术人员指导使用,注意系统兼容性。
Java版本
即将更新。
PHP版本
即将更新。