测试地址:https://ibstest.allinpay.com/yst/yst-service-api/tm/handle
生产地址:https://ibsapi.allinpay.com/yst-service-api/tm/handle
接口代码(transCode):1013
功能说明:
1.该接口仅支持企业会员以前台H5页面形式完成企业会员的注册+设置角色+企业实名信息采集(工商信息、法人信息、银行卡信息、影印件信息)+绑定手机号+账户提现协议、会员关系证明函签约;
2.链接有效期为7天,过期后打开链接提示:已过期,请重新开始企业会员开户H5流程;
3.若客户上送“backUrl-异步通知地址”,则云商通提供异步结果通知,其中企业信息采集完成,手机号绑定完成、账户协议提现协议签约完成均会给出异步通知;
4.若客户上送“jumpUrl-成功跳转页面地址”,则云商通在H5页面流程结束后跳转到该页面;
5.客户在微信小程序内调起签约功能的,采取跨小程序跳转方式对接,对接指引详见《小程序应用客户对接云商通H5页面类接口接入指引.docx》
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户请求流水号 |
商户系统内保持唯一,定义长度为50位 |
signNum |
String |
60 |
是 |
商户会员编号 |
已注册或未注册的会员 |
memberRole |
String |
60 |
否 |
会员角色 |
接口非必填,若上送,校验如下: (1)未注册会员/审核失败的会员(会员状态=审核失败),若上送角色,若“角色”选择“平台同主体”需要进行统一信用证一致性校验; (2)已注册会员设置角色(会员状态=待生效),必须与设置角色一致,否则报错 |
enterpriseName |
String |
60 |
是 |
企业名称 |
如有括号,用中文格式() |
enterpriseNature |
String |
1 |
否 |
企业性质: 1-企业 2-个体工商户 3-事业单位 |
接口非必填,不填则默认“企业” 若上送,则控制企业名称含“公司”,则企业性质不支持上送“2-个体工商户”,若上送,则接口响应提示“该企业会员非个体工商户!”; |
jumpPageType |
String |
1 |
否 |
跳转页面类型 |
1-H5页面 2-小程序页面 接口非必填,不上送默认跳转H5页面 |
backUrl |
String |
256 |
是 |
异步通知 |
必填,企业会员注册(H5)流程的异步通知地址; |
jumpUrl |
String |
256 |
否 |
成功跳转返回的页面地址 |
非必填,成功则跳转; |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
是 |
响应流水号 |
|
signNum |
String |
60 |
否 |
商户会员编号 |
00000,成功返回 |
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
否 |
失败原因 |
|
regInviteLink |
String |
256 |
否 |
会员注册链接 |
默认有效期7天 |
jumpUrl前端回调参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户请求流水号 |
商户系统内保持唯一,定义长度为50位 |
signNum |
String |
是 |
商户会员编号 |
|
enterpriseName |
String |
是 |
企业名称 |
如有括号,用中文格式() |
auditResult |
String |
是 |
审核结果: |
2:审核成功。 3:审核失败。 |
auditTime |
String |
是 |
审核时间 |
格式:20240226170408 |
remark |
String |
否 |
人工审核备注 |
|
auditResultMsg |
String |
否 |
失败原因 |
1.会员审核失败,则返回会员审核失败原因 |
enterpriseCompareResult |
String |
否 |
OCR识别与企业工商认证信息是否一致: 1-是 2-否 3-识别失败 |
页面上传影印件,识别比对结果变更,则发送 |
legalPersonCompareResult |
String |
否 |
OCR识别与企业法人实名信息是否一致: 1-是 2-否 3-识别失败 |
|
phone |
String |
否 |
绑定手机号 |
绑定手机号成功,发送 |
bindPhoneType |
String |
否 |
绑定手机号类型 |
|
withdrawAgreeStatus |
String |
否 |
企业/个人主体账户提现协议状态 |
页面签订账户提现协议,签订成功发送异步通知 |
withdrawAgreeNo |
String |
否 |
企业/个人主体账户提现协议签约编号 |
|
membershipNo |
String |
否 |
企业/个人主体会员关系证明函 签约编号 |
页面签订会员关系证明函,签订成功发送异步通知 |
membershipStatus |
String |
否 |
企业/个人主体会员关系证明函协议状态 0:未签约 1:签约成功 2:签约失败 3:签约中
|