目录
1.文件上传
接口说明:
- 上传文件,返回fileId
请求URL:
- /comm/uploadFile
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
fileType |
是 |
String(1) |
文件类型,3:证件材料 |
|
fileMd5 |
是 |
String |
文件流的MD5值 |
|
file |
是 |
String |
文件流,文件流不参与签名 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
fileId |
是 |
String(40) |
文件标识,长期有效 |
2.企业会员实名开户
接口说明:
- 用于企业会员注册
请求URL:
- /payMember/regEnterprise
请求方式:
- POST
请求类型:
- application/json
请求参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
memCategory |
是 |
String(2) |
会员种类: |
|
memRole |
否 |
String(11) |
会员角色: |
|
memSubType |
否 |
String(1) |
会员子类型:2-分账方 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代isv:yunst2isv |
|
notifyUrl |
是 |
String(250) |
企业会员开户结果通知地址 |
|
memAlias |
是 |
String(50) |
会员简称,可由客户自定义,校验唯一 |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
enterpriseInfo |
是 |
String |
企业信息 |
|
bankInfo |
是 |
String |
银行卡信息 |
企业信息:
|
参数名 |
必选 |
类型 |
说明 |
|
companyName |
是 |
String(50) |
企业名称,营业执照名称 |
|
companyAddress |
是 |
String(50) |
企业地址 |
|
companyAddrCode |
是 |
String(10) |
地区码,见附录[2.省市地区码](https://www.showdoc.com.cn/2511081072137898/11558563513285632 "2.省市地区码") |
|
authType |
是 |
String(11) |
认证类型 2:一证 |
|
uniCredit |
是 |
String(20) |
统一社会信用 |
|
effLicense |
否 |
String(20) |
统一社会信用生效日期 yyyy-mm-dd |
|
expLicense |
否 |
String(20) |
统一社会信用到期时间 yyyy-MM-dd |
|
legalName |
是 |
String(10) |
法人姓名 |
|
identityType |
是 |
String(1) |
证件类型 1-身份证 |
|
legalIds |
是 |
String(160) |
法人身份证,aes加密 |
|
legalPhone |
是 |
String(11) |
法人手机号 |
|
legalIdZFileId |
否 |
String(30) |
法人证件人像面影印件fileId |
|
legalIdFFileId |
否 |
String(30) |
法人证件国徽面影印件fileId |
|
uniCreditFileId |
否 |
String(30) |
统一社会信用代码影印件fileId |
银行卡信息:
|
参数名 |
必选 |
类型 |
说明 |
|
acctType |
是 |
String(1) |
账户类型 0-对私 1-对公 |
|
acctNo |
是 |
String(200) |
银行卡号 aes加密 |
|
bankPhoneNo |
否 |
String(11) |
银行卡绑定手机号,账户类型=0-对私时,则必填 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
openBankNo |
否 |
String(10) |
银行代码,账户类型=1-对公时,则必填,参见[附录3. 银行代码及支付行号](https://www.showdoc.com.cn/tppay/11558620330076069 "附录3. 银行代码及支付行号") |
|
bankName |
否 |
String(20) |
开户行支行名称,账户类型=1-对公时,则必填,参见附录3 |
|
unionBank |
否 |
String(20) |
支付行号,账户类型=1-对公时,则必填,参见附录3 |
|
openBankProvince |
是 |
String(20) |
开户行所在省,例 江苏省,上送 江苏 |
|
openBankCity |
是 |
String(20) |
开户行所在市,例 南京市,上送 南京 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
会员编号 |
测试环境测试数据模拟规则:
|
类型 |
规则 |
|
测试环境短信验证码 |
11111 |
|
对私卡绑定规则 |
{"卡号第四位为0","交易成功"} |
|
企业会员模拟识别成功结果 |
企业名称:竹溪县子怡鞋店 |
3.企业会员开户结果通知
请求URL:
- 该链接是通过企业会员实名开户接口提交的参数notifyUrl设置
请求方式:
- POST
请求类型:
- application/x-www-form-urlencoded
通知参数
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,有此参数需要用服务商密钥进行验签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若是服务商模式,则为服务商appId |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(2) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代:yunst2isv |
|
auditResult |
是 |
String(1) |
审核结果 2:通过 |
|
auditTime |
是 |
String(20) |
审核时间 格式:20240226170408 |
|
auditRemark |
否 |
String(200) |
人工审核备注 |
|
auditResultMsg |
否 |
String(200) |
失败原因 |
返回结果:
业务系统处理后同步返回给支付系统,返回字符串success 则表示成功,返回非success则表示处理失败,支付系统会再次通知。
注意:返回的字符串必须是小写,且前后不能有空格和换行符。
4.会员资料补录
接口说明:
- 用于企业会员注册影印件补录
请求URL:
- /payMember/regSupplement
请求方式:
- POST
请求类型:
- application/json
请求参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代isv:yunst2isv |
|
notifyUrl |
是 |
String(250) |
会员资料补录结果通知地址 |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
uniCreditFileId |
否 |
String(40) |
统一信用证fileId |
|
legalIdZFileId |
否 |
String(40) |
身份证人像面fileId |
|
legalIdFFileId |
否 |
String(40) |
身份证国徽面fileId |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
5.会员资料补录结果通知
请求URL:
- 该链接是通过会员资料补录接口提交的参数notifyUrl设置
请求方式:
- POST
请求类型:
- application/x-www-form-urlencoded
通知参数
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,有此参数需要用服务商密钥进行验签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若是服务商模式,则为服务商appId |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代:yunst2isv |
|
enterpriseCompareResult |
否 |
String(1) |
OCR识别与企业工商认证信息是否一致 |
|
legalPersonCompareResult |
否 |
String(1) |
OCR识别与企业法人实名信息是否一致 |
|
compareResults |
否 |
String(500) |
比对结果信息,多个“;”分隔 |
|
enterpriseInfo |
否 |
JSONObject |
企业影印件识别信息 |
|
legalPersonCardFaceInfo |
否 |
JSONObject |
法人影印件肖像面识别信息 |
|
legalPersonCardNationalEmblemInfo |
否 |
JSONObject |
法人影印件国徽面识别信息 |
企业影印件识别信息:
|
参数名 |
必选 |
类型 |
说明 |
|
respCode |
否 |
String(10) |
返回码 ,000000 成功,其他失败 |
|
respMsg |
否 |
String(10) |
失败原因 |
|
result |
否 |
String(10) |
识别结果 0-查询到数据 1-未查到数据 |
|
creditCode |
否 |
String(20) |
统一社会信用 |
|
corpName |
否 |
String(200) |
企业名称 |
|
forever |
否 |
String(10) |
有效期是否永久 true/false |
|
validate |
否 |
String(30) |
有效期 该字段当forever为false时有效,格式:yyyy/MM/dd,如:2999/12/31 |
法人影印件肖像面识别信息:
|
参数名 |
必选 |
类型 |
说明 |
|
respCode |
否 |
String(10) |
返回码 ,000000 成功,其他失败 |
|
respMsg |
否 |
String(10) |
失败原因 |
|
result |
否 |
String(10) |
识别结果 0-查询到数据 1-未查到数据 |
|
name |
否 |
String(100) |
姓名 |
|
idCard |
否 |
String(30) |
身份证号 |
|
gender |
否 |
String(10) |
性别 |
|
nation |
否 |
String(30) |
民族 |
|
birthday |
否 |
String(10) |
生日 格式如:1995/10/08 |
|
address |
否 |
String(500) |
地址 |
法人影印件国徽面识别信息:
|
参数名 |
必选 |
类型 |
说明 |
|
respCode |
否 |
String(10) |
返回码 ,000000 成功,其他失败 |
|
respMsg |
否 |
String(10) |
失败原因 |
|
result |
否 |
String(10) |
识别结果 0-查询到数据 1-未查到数据 |
|
validDate |
否 |
String(100) |
有效期 格式:yyyy/MM/dd-yyyy/MM/dd,如果长期则显示中文 |
|
unitName |
否 |
String(300) |
所属公安单位 |
|
isValid |
否 |
String(1) |
是否过期 1未过期,0已过期 |
返回结果:
业务系统处理后同步返回给支付系统,返回字符串success 则表示成功,返回非success则表示处理失败,支付系统会再次通知。
注意:返回的字符串必须是小写,且前后不能有空格和换行符。
6.会员绑定手机号申请
接口说明:
- 会员绑定手机号申请,用于绑定法人手机号或企业授权手机号
请求URL:
- /payMember/bindPhoneApple
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代isv:yunst2isv |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
phone |
是 |
String(11) |
绑定手机号 |
|
phoneType |
是 |
String(1) |
绑定类型 1-法人手机号 2-企业授权手机号 |
|
notifyUrl |
是 |
String(250) |
绑定手机号通知地址 |
|
jumpUrl |
是 |
String(250) |
前端跳转地址,仅绑定类型为2且授权类型为1上送,只支持H5 |
|
authPerInfo |
否 |
String |
被授权人信息,绑定类型为2,必传 |
被授权人信息:
|
参数名 |
必选 |
类型 |
说明 |
|
authPerType |
是 |
String(60) |
授权类型 1-线上 2-线下 |
|
authPerName |
是 |
String(60) |
授权人名称 |
|
authPerIdNo |
是 |
String(200) |
授权人证件号 aes加密 |
|
authPerIdType |
是 |
String(2) |
授权人证件类型 1-身份证 |
|
authProcotolFileId |
否 |
String(100) |
授权协议文件fileId,仅授权类型为2时传 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,3000-已受理待审核(线下授权返回),其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
applyRespTraceNum |
是 |
String(40) |
响应流水号 |
|
authSignLink |
否 |
String(255) |
授权手机号签约链接,只有绑定类型为2且授权类型是1返回 |
页面跳转说明:
jumpUrl参数:
|
参数名 |
必选 |
类型 |
说明 |
|
reqTraceNum |
是 |
String(50) |
请求流水号 |
|
signNum |
是 |
String(60) |
会员编号 对应入参bizUserId |
|
bindResult |
是 |
String(1) |
绑定结果 1:成功 |
|
phone |
是 |
String(2) |
绑定手机号 |
7.会员绑定手机号确认
接口说明:
- 会员绑定手机号上送短信验证码
请求URL:
- /payMember/bindPhoneConfirm
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代isv:yunst2isv |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
applyRespTraceNum |
是 |
String(40) |
申请响应业务关联流水号 |
|
phone |
是 |
String(11) |
绑定手机 |
|
verifyCode |
是 |
String(6) |
短信验证码 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
phone |
是 |
String(30) |
手机号 |
测试环境模拟规则:
|
类型 |
规则 |
|
测试环境短信验证码 |
11111 |
8.会员绑定手机号结果通知
请求URL:
- 该链接是通过会员绑定手机号申请接口提交的参数notifyUrl设置
请求方式:
- POST
请求类型:
- application/x-www-form-urlencoded
通知参数
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,有此参数需要用服务商密钥进行验签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若是服务商模式,则为服务商appId |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代:yunst2isv |
|
bindResult |
是 |
String(1) |
绑定结果 1:成功 2:失败 |
|
bindErrorMsg |
否 |
String(200) |
绑定失败原因 |
|
bindTime |
否 |
String(20) |
绑定时间 |
|
phone |
否 |
String(11) |
绑定手机号 |
|
phoneType |
否 |
String(1) |
绑定手机类型 1-法人手机号 2-企业授权手机号 |
返回结果:
业务系统处理后同步返回给支付系统,返回字符串success 则表示成功,返回非success则表示处理失败,支付系统会再次通知。
注意:返回的字符串必须是小写,且前后不能有空格和换行符。
9.个人会员实名及绑卡
接口说明:
- 用于分账方的个人会员实名注册,个人会员实名绑卡后,无需调用会员绑定手机号接口,会员绑定的手机号默认为银行卡预留手机号
请求URL:
- /payMember/regPerson
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
memRole |
否 |
String(11) |
会员角色:chanNo为yunst2isv时必填 |
|
memSubType |
否 |
String(1) |
会员角色:2-分账方 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代isv:yunst2isv |
|
memAlias |
是 |
String(50) |
会员简称 |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
memInfo |
是 |
jsonObject字符串 |
个人信息 |
|
bankInfo |
是 |
jsonObject字符串 |
银行卡信息 |
个人信息:
|
参数名 |
必选 |
类型 |
说明 |
|
idenName |
是 |
String(32) |
姓名 |
|
idenNo |
是 |
String(120) |
证件号码,aes加密 |
|
identityType |
是 |
String(1) |
证件类型 1-身份证 |
银行卡信息:
|
参数名 |
必选 |
类型 |
说明 |
|
acctNo |
是 |
String(200) |
银行卡号 aes加密 |
|
bankPhoneNo |
是 |
String(11) |
银行卡绑定手机号 |
|
validDate |
否 |
String(4) |
有效期,格式为月年;如0321,2位月2位年 |
|
cvv2 |
否 |
String(3) |
CVV2 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
int |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
会员编号 |
模拟规则:
|
类型 |
规则 |
|
对私卡绑定规则 |
{"卡号第四位为0","交易成功"} |
10.会员信息查询
请求URL:
- /payMember/getRegState
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
String |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
memAlias |
是 |
String(50) |
会员简称 |
|
memCategory |
是 |
String(2) |
会员种类 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
memSubType |
是 |
String(1) |
会员子类型 |
|
memNo |
是 |
String(30) |
通企付会员编号 |
|
phoneNo |
否 |
String(11) |
绑定手机号 |
|
memInfo |
否 |
jsonObject |
个人信息 |
|
enterpriseInfo |
否 |
jsonObject |
企业信息 |
|
bankList |
否 |
jsonArray |
绑卡信息 |
|
chanList |
是 |
jsonArray |
渠道注册信息 |
个人信息:
|
参数名 |
必选 |
类型 |
说明 |
|
idenName |
否 |
String(10) |
身份证名称 |
|
idenNo |
否 |
String(18) |
身份证号 |
企业信息:
|
参数名 |
必选 |
类型 |
说明 |
|
companyName |
是 |
String(50) |
企业名称 |
|
companyAddress |
是 |
String(50) |
企业地址 |
|
authType |
是 |
String(11) |
认证类型 1:三证 2:一证 |
|
businessLicense |
是 |
String(50) |
统一社会信用代码或营业执照号 |
|
organizationCode |
否 |
String(50) |
组织机构代码,三证时返回 |
|
taxRegister |
否 |
String(50) |
纳税人识别号,三证时返回 |
|
expLicense |
否 |
String(50) |
营业证件有效期 |
|
legalName |
是 |
String(10) |
法人姓名 |
|
identityType |
是 |
String(1) |
证件类型 1-身份证 |
|
legalIds |
是 |
String(18) |
法人身份证 |
|
legalPhone |
是 |
String(11) |
法人手机号 |
|
accountNo |
是 |
String(20) |
银行账号 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
bankName |
否 |
String(20) |
开户行支行 |
|
unionBank |
否 |
String(20) |
支付行号 |
|
legalIdZOCRResult |
否 |
String(1) |
法人证件人像面影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
|
legalIdFOCRResult |
否 |
String(1) |
法人证件国徽面影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
|
uniCreditOCRResult |
否 |
String(1) |
统一社会信用代码影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
绑卡信息:
|
参数名 |
必选 |
类型 |
说明 |
|
acctType |
是 |
String(1) |
账户类型 0- 对私 1- 对公 |
|
acctNo |
是 |
String(200) |
银行卡号 |
|
bankPhoneNo |
否 |
String(11) |
银行卡绑定手机号,账户类型=0-对私,则必填 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
openBankNo |
否 |
String(10) |
银行代码,账户类型=1-对公,则必填 |
|
bankName |
否 |
String(20) |
开户行支行名称,账户类型=1-对公,则必填 |
|
unionBank |
否 |
String(20) |
支付行号,账户类型=1-对公,则必填 |
|
openBankProvince |
否 |
String(20) |
开户行所在省,例 江苏省,上送 江苏 |
|
openBankCity |
否 |
String(20) |
开户行所在市,例 南京市,上送 南京 |
注册渠道信息:
|
参数名 |
必选 |
类型 |
说明 |
|
chanNo |
否 |
String(10) |
渠道编码 |
|
regState |
否 |
String(11) |
状态 |
11.会员协议签约申请
请求URL:
- /payMember/applyMemProtocol
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
serialNo |
是 |
String(32) |
商户请求流水号 |
|
bizUserId |
是 |
String(30) |
收款方商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代:yunst2isv |
|
protocolType |
是 |
String |
协议类型 1-分账协议 |
|
divisionMemInfo |
否 |
String |
分账协议信息,分账协议必传 |
|
couponInfo |
否 |
String |
抽佣协议信息,抽佣协议必传 |
|
notifyUrl |
是 |
String(128) |
签约结果和审核结果异步回调URL,只有传了该值才会发起回调 |
|
jumpPageType |
否 |
String(1) |
跳转页面类型1-H5页面 2-小程序页面,不送默认H5 |
|
jumpUrl |
否 |
String(128) |
前端跳转地址 |
分账协议信息:
|
参数名 |
必选 |
类型 |
说明 |
|
divisionBizUserId |
是 |
String(10) |
分账方商户会员编号 |
|
divisionType |
是 |
String(1) |
分账方式 1:分账比例 |
|
divisionRate |
是 |
String(6) |
最高分账比例,最多4位小数,如最高分账比例为5.55%,填写0.0555 |
|
divisionProcotolFileId |
是 |
String(100) |
分账业务佐证材料的fileId,需要先使用文件上传接口获取 |
抽佣协议信息:
|
参数名 |
必选 |
类型 |
说明 |
|
couponType |
是 |
String(1) |
抽佣方式 1:分账比例 |
|
couponRate |
是 |
String(6) |
具体抽佣比例,最多4位小数,如分账比例为5.55%,填写0.0555 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
string |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
recSignLink |
否 |
String(512) |
收款方签约链接 |
|
divSignLink |
否 |
String(512) |
分账方签约链接 , 分账协议返回 |
|
protocolLinkEndTime |
否 |
String(30) |
签约链接失效时间 2024-10-10 09:16:00 |
页面跳转说明:
jumpUrl参数:
|
参数名 |
必选 |
类型 |
说明 |
|
reqTraceNum |
是 |
String(50) |
请求流水号 |
|
signNum |
是 |
String(60) |
签约会员编号,同bizUserId |
|
memberName |
是 |
String(200) |
签约会员名称 |
|
couponAgreeStatus |
否 |
String(1) |
平台抽佣协议状态 签署抽佣协议返回 |
|
couponAgreementNo |
否 |
String(32) |
平台抽佣协议签约编号 签署抽佣协议返回 |
|
sepAgreeStatus |
否 |
String(1) |
分账协议状态 签署分账协议返回 |
|
sepAgreeNo |
否 |
String(32) |
分账协议编号 签署分账协议返回 |
12.会员协议签约结果通知
请求URL:
- 该链接是通过会员协议签约申请接口提交的参数notifyUrl设置
请求方式:
- POST
请求类型:
- application/x-www-form-urlencoded
通知参数
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,有此参数需要用服务商密钥进行验签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若是服务商模式,则为服务商appId |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道,云商通二代:yunst2isv |
|
noticeType |
是 |
String(1) |
通知类型 1-签约结果 2-审核结果 |
|
protocolType |
是 |
String(1) |
协议类型 1-分账协议 |
|
divisionProtocolState |
是 |
String(1) |
分账协议签约状态 |
|
couponProtocolState |
否 |
String(1) |
抽佣协议签约状态 |
|
auditResult |
否 |
String(1) |
审批状态 1-通过 2-拒绝 分账协议且通知类型是审核结果时返 |
|
auditTime |
否 |
String(20) |
审核时间 格式:20240226170408 分账协议且通知类型是审核结果时返 |
|
auditResultMsg |
否 |
String(200) |
拒绝原因 分账协议且通知类型是审核结果返 |
|
divisionProtocolNo |
是 |
String(64) |
分账协议编号 |
|
divisionMemInfo |
是 |
JSONObject |
分账协议信息 |
|
couponProtocolNo |
否 |
String(64) |
抽佣协议编号,分账协议必传 |
|
couponInfo |
否 |
JSONObject |
抽佣协议信息,抽佣协议必传 |
分账协议信息:
|
参数名 |
必选 |
类型 |
说明 |
|
divisionBizUserId |
是 |
String(10) |
分账会员编号 |
|
divisionType |
是 |
String(1) |
分账方式 1:分账比例 |
|
divisionRate |
是 |
String(6) |
分账比例,例5.55%,返回0.0555 |
抽佣协议信息:
|
参数名 |
必选 |
类型 |
说明 |
|
couponType |
是 |
String(1) |
抽佣方式 1:分账比例 |
|
couponRate |
是 |
String(6) |
抽佣比例,例5.55%,返回0.0555 |
返回结果:
业务系统处理后同步返回给支付系统,返回字符串success 则表示成功,返回非success则表示处理失败,支付系统会再次通知。
注意:返回的字符串必须是小写,且前后不能有空格和换行符。
13.会员注册邀请码生成
接口说明:
- 用于会员注册,返回会员信息采集H5页面链接。会员信息如接口有上送,则会在H5页面反显并允许修改。
请求URL:
- /payMember/generateRegInviteLink
请求方式:
- POST
请求类型:
- application/json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
chanNo |
是 |
String(10) |
渠道 |
|
memCategory |
是 |
String(2) |
会员种类 |
|
memSubType |
是 |
String(1) |
会员类型:2-分账方 |
|
memRole |
否 |
String(11) |
会员角色, |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
memAlias |
是 |
String(50) |
会员简称 |
|
notifyUrl |
否 |
String(128) |
注册成功结果异步回调URL |
|
jumpUrl |
否 |
String(128) |
页面跳转地址,返回拼接bizUserId和 regState |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
phoneNo |
否 |
String(11) |
手机号(绑定手机号) |
|
memInfo |
否 |
jsonObject |
个人信息 |
|
enterpriseInfo |
否 |
jsonObject |
企业信息 |
|
bankInfo |
否 |
jsonObject |
绑卡信息 |
个人信息:
|
参数名 |
必选 |
类型 |
说明 |
|
idenName |
否 |
String(10) |
身份证名称 |
|
idenNo |
否 |
String(18) |
身份证号 |
企业信息:
|
参数名 |
必选 |
类型 |
说明 |
|
companyName |
否 |
String(50) |
企业名称 |
|
companyAddress |
否 |
String(50) |
企业地址 |
|
authType |
否 |
String(11) |
认证类型 2:一证 |
|
telephone |
否 |
String(11) |
联系电话 |
|
legalName |
否 |
String(10) |
法人姓名 |
|
identityType |
否 |
String(1) |
证件类型 1-身份证 |
|
legalIds |
否 |
String(18) |
法人身份证 |
|
legalPhone |
否 |
String(11) |
法人手机号 |
|
accountNo |
否 |
String(20) |
企业对公账户 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
bankName |
否 |
String(20) |
开户行支行 |
|
unionBank |
否 |
String(20) |
支付行号(12位) |
绑卡信息:
|
参数名 |
必选 |
类型 |
说明 |
|
acctNo |
否 |
String(20) |
银行卡号 |
|
bankPhoneNo |
否 |
String(11) |
银行卡绑定手机号 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
int |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
regInviteLink |
是 |
String(512) |
注册链接 |
|
regInviteLinkEndTime |
是 |
String(30) |
到期时间 2022-10-10 09:16:00 |
模拟规则:
|
类型 |
规则 |
|
测试环境短信验证码 |
11111 |
|
对私卡绑定规则 |
{"卡号第四位为0","交易成功"} |
|
企业会员模拟识别成功结果 |
企业名称:竹溪县子怡鞋店 |
14.会员注册成功通知
请求URL:
- 通知地址可在核心企业后台配置“开户结果通知地址”参数设置或者通过会员注册邀请码生成接口上送
- 优先使用会员注册邀请码生成接口上送的通知地址
- 通过核心企业后台注册默认使用MD5加签;通过会员注册邀请码生成接口注册则使用接口上送签名类型加签
请求方式:
- POST
请求类型:
- application/x-www-form-urlencoded
通知参数
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,有此参数需要用服务商密钥进行验签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若是服务商模式,则为服务商appId |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型 MD5 |
|
memAlias |
是 |
String(50) |
会员简称 |
|
memCategory |
是 |
String(2) |
会员种类 |
|
bizUserId |
是 |
String(2) |
商户会员编号 |
|
memSubType |
是 |
String(2) |
会员类型 |
|
memNo |
是 |
String(2) |
通企付会员编号 |
|
phoneNo |
否 |
String(2) |
绑定手机号 |
|
memInfo |
否 |
jsonObject |
个人信息 |
|
enterpriseInfo |
否 |
jsonObject |
企业信息 |
|
bankList |
否 |
jsonArray |
绑卡信息 |
|
chanList |
是 |
jsonArray |
渠道注册信息 |
个人信息:
|
参数名 |
必选 |
类型 |
说明 |
|
idenName |
是 |
String(10) |
身份证名称 |
|
idenNo |
是 |
String(18) |
身份证号 |
企业信息:
|
参数名 |
必选 |
类型 |
说明 |
|
companyName |
是 |
String(50) |
企业名称 |
|
companyAddress |
是 |
String(50) |
企业地址 |
|
authType |
是 |
String(11) |
认证类型 1:三证 2:一证 |
|
businessLicense |
是 |
String(50) |
统一社会信用代码或营业执照号 |
|
organizationCode |
否 |
String(50) |
组织机构代码,三证时返回 |
|
taxRegister |
否 |
String(50) |
纳税人识别号,三证时返回 |
|
expLicense |
否 |
String(50) |
营业证件有效期 |
|
legalName |
是 |
String(10) |
法人姓名 |
|
identityType |
是 |
String(1) |
证件类型 1-身份证 |
|
legalIds |
是 |
String(18) |
法人身份证 |
|
legalPhone |
是 |
String(11) |
法人手机号 |
|
accountNo |
是 |
String(20) |
银行账号 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
bankName |
否 |
String(20) |
开户行支行 |
|
unionBank |
否 |
String(20) |
支付行号 |
|
legalIdZOCRResult |
否 |
String(1) |
法人证件人像面影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
|
legalIdFOCRResult |
否 |
String(1) |
法人证件国徽面影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
|
uniCreditOCRResult |
否 |
String(1) |
统一社会信用代码影印件处理结果 0-待上传 1-识别中 2-识别通过 3-识别失败 |
绑卡信息:
|
参数名 |
必选 |
类型 |
说明 |
|
acctType |
是 |
String(1) |
账户类型 0- 对私 1- 对公 |
|
acctNo |
是 |
String(200) |
银行卡号 |
|
bankPhoneNo |
否 |
String(11) |
银行卡绑定手机号,账户类型=0-对私,则必填 |
|
parentBankName |
否 |
String(20) |
开户行名称 |
|
openBankNo |
否 |
String(10) |
银行代码,账户类型=1-对公,则必填 |
|
bankName |
否 |
String(20) |
开户行支行名称,账户类型=1-对公,则必填 |
|
unionBank |
否 |
String(20) |
支付行号,账户类型=1-对公,则必填 |
|
openBankProvince |
否 |
String(20) |
开户行所在省,例 江苏省,上送 江苏 |
|
openBankCity |
否 |
String(20) |
开户行所在市,例 南京市,上送 南京 |
注册渠道信息:
|
参数名 |
必选 |
类型 |
说明 |
|
chanNo |
是 |
String(10) |
渠道编码 |
|
chanAuditResult |
否 | String(2) | 渠道审核状态 2-通过 3-失败 |
| chanAuditResultMsg | 否 | String(250) | 渠道审核失败原因 |
|
regState |
是 |
String(11) |
状态 |
返回结果:
业务系统处理后同步返回给支付系统,返回字符串success 则表示成功,返回非success则表示处理失败,支付系统会再次通知。
注意:返回的字符串必须是小写,且前后不能有空格和换行符。
15.会员绑定收银宝商户号开户
接口说明:
- 通过绑定收银宝商户号注册会员
请求URL:
- /payMember/regBindSybCusId
请求方式:
- POST
请求类型:
- application /json
参数:
|
参数名 |
必选 |
类型 |
说明 |
|
orgId |
否 |
string |
服务商id,用于服务商代发起交易,传了此参数需要用服务商密钥进行加签 |
|
mchNo |
是 |
String(30) |
商户号 |
|
appId |
是 |
String(24) |
默认为企业appId,若为服务商模式,需传入服务商appId |
|
reqTime |
是 |
String(13) |
请求时间,13位时间戳 |
|
version |
是 |
String(3) |
接口版本,固定:1.0 |
|
sign |
是 |
String(32) |
签名 |
|
signType |
是 |
String(32) |
签名类型,MD5/RSA/SM2 |
|
memSubType |
否 |
String(1) |
会员角色:1-收款方 |
|
memRole |
否 |
String(11) |
会员角色: |
|
bizUserId |
是 |
String(30) |
商户会员编号 |
|
chanNo |
是 |
String(10) |
渠道 云商通二代isv:yunst2isv |
|
memAlias |
是 |
String(50) |
会员简称 |
|
serialNo |
是 |
String(32) |
请求流水号 |
|
sybCusId |
是 |
String(32) |
收银宝商户号 |
|
isCoupon |
否 |
String(1) |
是否抽佣,1-是-0-否 |
返回参数
|
参数名 |
必选 |
类型 |
说明 |
|
code |
是 |
int |
返回状态:0-处理成功,其他-处理有误,具体错误详见msg字段 |
|
msg |
否 |
String(128) |
返回信息:具体错误原因,例如:签名失败、参数格式校验错误 |
|
sign |
否 |
String(32) |
签名信息:对data内数据签名,如data为空则不返回 |
|
data |
否 |
Json |
返回数据:json格式数据 |
data数据格式
|
参数名 |
必选 |
类型 |
说明 |
|
bizUserId |
是 |
String(30) |
会员编号 |