会员及账户类接口
【文件上传】接口——公共接口
功能说明:
上传文件,返回fileId,有效期30分钟。
请求参数(含公共请求参数)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
appId |
String |
是 |
应用号 |
|
spAppId |
String |
否 |
服务商应用号 |
|
fileType |
String |
是 |
文件类型 |
上送:3:证件材料 |
md5 |
String |
是 |
文件的MD5值 |
|
sign |
String |
是 |
签名 |
将spAppId+appId+fileType+md5+timestamp值拼接后使用SM3withSM2进行签名后base64编码生成的字符串 |
file |
file |
是 |
文件流 |
文件大小控制在2M以内 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
fileId |
String |
40 |
否 |
文件标识 |
00000-交易成功,返回,有效期30分钟 |
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
返回说明 |
【企业最终受益人信息查询】接口
功能说明:
企业最终受益人信息查询,作为企业开户时受益人信息的辅助接口,防止开户申请时受益人信息与企业真实受益人信息不一致而被驳回。
接口代码:4031
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户请求流水号 |
||
signNum |
String |
是 |
商户会员编号 |
||
enterpriseName |
String |
是 |
企业名称 |
||
unifiedSocialCredit |
String |
是 |
统一社会信用 |
||
legalPersonName |
String |
是 |
法人姓名 |
||
legalPersonCerNum |
String |
否 |
法人证件号码 |
明文上送 |
|
legalPersonPhone |
String |
否 |
法人手机号码 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
respCode |
String |
是 |
返回码 |
|
respMsg |
String |
否 |
失败原因 |
|
enterpriseBene |
JSONArray |
否 |
企业最终受 |
查询成功则返回 |
受益人信息
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
beneficiaryName |
String |
是 |
受益所有人名称 |
|
incomeWay |
是 |
受益人受益方 |
A01:直接或间接控股25%(含)以上 A02:通过人事、财务等其他方式对公司进行控制 A03:高级管理人员 A04:法人或公司负责人 A05:其他 |
|
shareholdingRatio |
是 |
最终受益人持股比 |
【企业会员实名开户】接口
功能说明:
1、支持企业性质:企业、个体工商户、事业单位的企业会员开立簿记户,对于个体工商户支持绑定对私银行账户;
2、支持未注册或会员状态=待生效、审核失败的企业会员进行实名,实名认证通过,开立簿记账户。
3、企业会员实名认证流程:按顺序触发-企业工商要素验证->法人实名认证->对公银行账户信息留存/对私银行账户认证:三个认证环节,无论上一环节是否认证成功,下一环节均发送渠道认证,并在运营平台【企业基本信息】记录信息及认证结果信息;
- 企业工商要素验证:企业名称,统一信用代码、法人名称;
- 法人认证要素:法人姓名,法人证件号、法人证件类型;
- 对私银行认证要素:法人名称、法人证件号、法人证件类型、银行卡号、预留手机号;
4、接口支持上送影印件信息,当企业会员工商信息、法人实名信息、银行账户信息均认证成功,则会员状态=有效时,进行影印件OCR识别比对,并通过【会员资料补录结果通知】(接口代码1022)接口通知商户影印件OCR识别比对结果、【企业会员簿记开户审核结果通知】(接口代码1020)通知商户企业审核结果。
认证结果处理逻辑:
(1)均认证成功,即实名认证成功,会员状态=有效;
(2)任一认证结果失败,即实名认证失败,会员状态=审核失败,支持通过此接口重新实名。
(3)针对法人非身份证证件类型,若“企业工商要素认证成功+银行账户认证成功”,则接口响应“审核失败”(会员状态=审核失败),“失败原因”提示“法人证件类型非身份证类型,需人工审核”;商户继续上传影印件,走运营平台人工审核流程,审核通过,则会员状态=“有效”。
(4)针对个体工商且营业证件名称为“*”或者是空的情况,企业工商要素验证时,仅比对证件号、法人信息,验证通过后系统自动将“会员名称”置为“个体户+法人姓名”的格式,如“个体户张三”,不取接口上送的企业名称。
4.因测试环境渠道使用挡板测试,请用以下信息进行企业会员设置企业信息操作,以模拟识别成功结果:
企业名称:竹溪县子怡鞋店;
认证类型:一证;
统一社会信用代码:92420324MA4D68J28J;
法人姓名:王三华;法人证件类型:身份证,法人证件号码:420324197711160623;
接口代码:1020
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户请求流水号 |
商户系统内保持唯一,定义长度为50位 |
|
signNum |
String |
是 |
商户会员编号 |
若平台会员编号,上送#yunBizUserId_B2C# |
|
memberRole |
String |
否 |
会员角色 |
(1)未注册,必须上送角色 (2)已注册,无需上送,上送则需要与设置的角色一致 |
|
notifyUrl |
String |
是 |
企业会员审核结果通知地址 |
如下情况,企业会员信息实名成功/失败均发送通知: (1)接口自动完成实名 (2)运营平台人工审核后 |
|
enterpriseBaseInfo |
JSONObject |
是 |
企业基本信息 |
||
bankAcctDetail |
JSONObject |
是 |
银行账户信息 |
||
JSONObject |
否 |
企业详情信息 |
|||
bankAcctReqInfo |
JSONObject |
否 |
银行开户请求信息 |
仅银行管理或银行托管,可上送 |
企业基本信息
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
String |
是 |
企业名称 |
如有括号,用中文格式() |
|
enterpriseNature |
String |
否 |
企业性质: 1-企业 2-个体工商户 3-事业单位 |
不填,则默认“企业” 注:企业名称含“公司”,不支持上送“个体工商户” |
addressCode |
String |
是 |
地区码(企业注册地所在省市区) |
见数据字段 |
enterpriseAdress |
String |
是 |
企业注册地地址 |
|
unifiedSocialCredit |
String |
是 |
统一社会信用 |
|
busLicenseValidate |
String |
否 |
营业证件有效期 |
针对华通银行(企业性质),必填 |
busLicenseLicEffDate |
String |
否 |
营业执照生效日期 |
针对华通银行(企业性质),必填 |
legalPersonName |
String |
是 |
法人姓名 |
|
String |
是 |
法人证件类型 |
||
legalPersonCerNum |
String |
是 |
法人证件号码 |
SM4加密,详细 |
idValidateStart |
String |
否 |
法人证件有效开始日期 |
格式:9999-12-31 华通银行,必填 新网银行,必填 |
idValidateEnd |
String |
否 |
法人证件有效截止日期 若长期有效上送“9999-12-31” |
格式:9999-12-31 若长期有效上送“9999-12-31” 华通银行,必填 新网银行,必填 |
legalPersonPhone |
String |
是 |
法人手机号码 |
|
legpCerFrontFileId |
String |
否 |
法人身份证(肖像面)token |
通过【文件上传下载接口】上传文件图片后获取的fileId,有效期30分钟,图片不超过2M 法人身份证证件类型:肖像面和国徽面必须同时上传。 法人非身份证证件类型:仅上传“法人身份证(肖像面)token”即可。 华通银行,必填 新网银行,必填 |
legpCerBackFileId |
String |
否 |
法人身份证(国徽面)token |
|
unifiedSocialCreditFileId |
String |
否 |
统一信用证token |
银行账户信息
字段 |
类型 |
必填 |
字段名称 |
说明 |
bankCardNo |
String |
是 |
银行卡号 |
SM4加密,详细。 |
bankAccountName |
String |
是 |
银行户名 |
|
bankName |
String |
是 |
银行名称 |
|
bindTime |
String |
是 |
绑定时间 |
yyyy-MM-dd HH:mm:ss |
cardType |
String |
是 |
银行卡类型 |
|
bindStatus |
String |
是 |
绑定状态 |
|
bankReservePhone |
String |
否 |
银行预留手机号码 |
|
bindType |
String |
否 |
绑卡方式 |
对公,为空 |
acctAttr |
String |
是 |
银行卡/账户属性 |
0:对私 1:对公 |
openBankBranchName |
String |
否 |
开户行支行名称 |
如:“中国工商银行股份有限公司北京樱桃园支行” |
payBankNumber |
String |
否 |
支付行号 |
12位数字 |
openBankProvince |
String |
否 |
开户行所在省 |
开户行所在市必须同时上送 根据中国省市表的“省份”内容填写。详情 |
openBankCity |
String |
否 |
开户行所在市 |
开户行所在省必须同时上送 根据中国省市表的“城市”内容填写。详情 |
isSpecifyAcct |
String |
是 |
是否为支付账户指定出入金银行账户 |
|
银行开户请求信息
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
openBankNo |
String |
是 |
开户银行编码 |
校验与配置的开户银行一致 新网银行:1024 |
企业详细信息
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
enterpriseScale |
String |
否 |
企业规模 |
针对华通银行(企业性质),必填 |
enterpriseType |
String |
否 |
企业类型 |
针对华通银行(企业性质),必填 |
economicNature |
String |
否 |
企业经济性质 |
针对华通银行(企业性质),必填 |
country |
String |
否 |
国籍 |
针对华通银行,必填 |
regCapital |
String |
否 |
企业注册资本 单位:元 |
针对华通银行(企业性质),必填 |
occupation |
String |
否 |
行业 |
针对华通银行,必填(个体工商户,上送职业枚举值) 新网银行,必填 |
businessBeginDate |
String |
否 |
公司经营开始时间 格式:yyyy-MM-dd |
针对华通银行(企业性质),必填 |
businessEndDate |
String |
否 |
公司经营结束日期 格式:yyyy-MM-dd |
针对华通银行(企业性质),必填 |
contactMobile |
String |
否 |
企业联系人手机号 |
针对华通银行(企业性质),必填 |
linkAddresscode |
String |
否 |
经营地址省市区/企业联系地址所在省市区,地区码 |
针对华通银行(企业性质),必填 |
enterpriseAddress |
String |
否 |
经营详细地址/企业联系地址 |
针对华通银行(企业性质),必填 新网银行,必填 |
businessScope |
String |
否 |
经营范围 |
针对华通银行(企业性质),不上送 |
openLicenseCode |
String |
否 |
开户许可证核准号或基本存款账户编号 |
针对华通银行(企业性质),不上送 |
openLicenseToken |
String |
否 |
开户许可证文件 |
针对华通银行(企业性质),不上送 |
legalAuthFileId |
String |
否 |
企业法人授 |
经办人与法人不一致,必填 |
shareholderInfo |
JSONObect |
否 |
控股股东/实际控制人 |
针对华通银行(企业性质),必填 新网银行,必填 |
beneficiaryInfo |
JSONObect |
否 |
受益所有人信息 |
针对华通银行(企业性质),必填 新网银行,必填 |
contactInfo |
JSONObect |
否 |
企业联系人信息 |
新网银行,必填 |
【控股股东/实际控制人】对象
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
shareholderName |
String |
否 |
控股股东/实际控制人名称 |
|
shareholderCertType |
String |
否 |
控股股东/实际控制人证件类型 |
|
shareholderCertNo |
String |
否 |
控股股东/实际控制人证件号 |
无需加密 |
shareholderCertBeginDate |
String |
否 |
控股股东/实际控制人证件开始日期 |
YYYY-MM-DD |
shareholderCertEndDate |
String |
否 |
控股股东/实际控制人证件截止日期 |
长期:9999-12-31 |
shareholderPhone |
String |
否 |
股东或实际控制人电话 |
|
shareholdingRatio |
String |
否 |
控投股东持 |
|
shareholderCertFrontToken |
String |
否 |
控股人身份证(肖像面)token |
|
shareholderCertBackToken |
String |
否 |
控股人身份证(国徽面)token |
【受益所有人】对象
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
beneficiaryName |
String |
否 |
受益所有人名称 |
|
beneficiaryAddress |
String |
否 |
受益所有人地址 |
|
beneficiaryPhone |
String |
否 |
受益所有人电话 |
|
beneficiaryIdType |
String |
否 |
受益所有人证件类型 |
|
beneficiaryIdNo |
String |
否 |
受益所有人证件号码 |
无需加密,明文上送 |
beneficiaryIdEffDate |
String |
否 |
受益所有人证件开始日期 |
|
beneficiaryIdOffDate |
String |
否 |
受益所有人证件到期日期 |
|
incomeWay |
String |
否 |
受益人受益方 |
A01:直接或间接控股25%(含)以上 A02:通过人事、财务等其他方式对公司进行控制 A03:高级管理人员 A04:法人或公司负责人 A05:其他 |
shareholdingRatio |
String |
否 |
最终受益人持股比 |
可选(如果是50 |
beneficiaryConfirmId |
String |
否 |
企业最终受 |
|
beneficiaryCertFrontToken |
String |
否 |
企业受益人身份证(肖像面)token |
|
beneficiaryCertBackToken |
String |
否 |
企业受益人身份证(国徽面)token |
【企业联系人】对象
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
contactName |
String |
否 |
企业联系 |
|
contactPhone |
String |
否 |
企业联系 |
|
contactCertType |
String |
否 |
企业联系人证件类 |
|
contactCertNum |
String |
否 |
企业联系人证件号 |
明文上送 |
contactCertBeginDate |
String |
否 |
联系人证件起始日 |
格式:9999-12-31 |
contactCertEndDate |
String |
否 |
联系人证件截止日 |
长期则上送:9999-12-31 |
contactCertFrontId |
String |
否 |
企业联系人身份证(肖像面)token |
|
contactCertFrontId |
String |
否 |
企业联系人身份证(国徽面)token |
|
contactAuthFileId |
String |
否 |
企业联系人 |
联系人和法人不一致,必填 |
响应请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
业务正常处理,则返回 |
|
signNum |
String |
否 |
商户会员编号 |
||
bankAcctResInfo |
JSONObect |
否 |
银行开户响应信息 |
新网银行,不返回 |
|
respCode |
String |
是 |
业务返回码 |
定义银行返回“审核中”或“失败”的返回码 |
|
respMsg |
String |
是 |
失败原因 |
银行返回“审核中”,则返回“银行开户已受理,处理中”; 银行返回“失败”,则透传银行失败原因 |
【企业会员簿记开户审核结果通知】
功能说明:
1.【企业会员实名开户】接口审核成功、审核失败,均发送通知;
2.云商通运营平台人工审核通过/审核不通过,均发送通知;
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户请求流水号 |
商户系统内保持唯一,定义长度为50位 |
signNum |
String |
60 |
是 |
商户会员编号 |
|
auditResult |
String |
1 |
是 |
审核结果: |
2:审核成功。 3:审核失败。 4: 审核中 |
auditTime |
String |
20 |
是 |
审核时间 |
格式:20240226170408 |
remark |
String |
200 |
否 |
备注 |
|
auditResultMsg |
String |
200 |
否 |
失败原因 |
“待联系人短信认证” “待法人短信认证” “银行开户成功” 失败,透传银行开户失败原因 |
【小额打款金额验证】接口
功能说明:
企业开户或绑卡流程可能会触发小额打款验证,需提前与新网确认,新网向企业银行账号进行一笔小额打款,需要合作方调用此接口完成小额打款验证
接口代码:4030
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
请求流水号 |
|
verifyType |
String |
是 |
验证类型 |
OPEN_ACCT:开户 BIND_CARD:绑卡 |
oriRespTraceNum |
String |
是 |
原业务响应流水号 |
【企业会员实名开户】接口的响应流水号 【银行用户信息绑卡】接口响应流水号 |
amount |
Long |
是 |
打款金额 |
单位:分 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
respMsg |
String |
否 |
失败原因 |
|
verifyResult |
否 |
小额打款验证结果 |
1:验证成功: 2:验证失败 |
|
bindResult |
否 |
绑卡结果 |
1:绑卡成功 2:绑卡失败 |
【银行发送短信验证码】接口
功能说明:
发送短信验证码,目前仅支持新网银行,验证码5分钟内有效;
接口代码:4032
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户请求流水号 |
||
phone |
String |
否 |
手机号 |
BINDING_CARD:绑卡,必填 |
|
smsType |
String |
是 |
短信类型 |
OPEN_ACCT_SMS_CONT OPEN_ACCT_SMS_LEGAL_AUTH:企业开户法人认证短信 BINDING_CARD:绑卡 |
|
oriRespTraceNum |
String |
否 |
原开户响应流水号 |
当短信类型为以下枚举时,必填OPEN_ACCT_SMS_CONTACT_AUTH、OPEN_ACCT_SMS_LEGAL_AUTH 说明:【企业会员实名开户】接口响应流水号 |
|
cardNum |
否 |
绑定卡号 |
当短信类型为以下枚举时必传 |
||
electAcctNo |
否 |
电子 |
当短信类型为以下枚举时必传 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
respCode |
String |
是 |
业务码 |
发送验证码成功/失败,定义“返回码” |
respMsg |
String |
否 |
失败原因 |
【企业开户短信验证码校验】接口
功能说明:
企业开户短信验证码校验,目前仅支持新网银行
接口代码:4033
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户请求流水号 |
||
verifyType |
String |
否 |
验证类型 |
OPEN_ACCT_SMS_CONTACT_AUTH:联系人确认 OPEN_ACCT_SMS_LEGAL_AUTH:法人确认 |
|
oriRespTraceNum |
是 |
开户响应流水号 |
【企业实名开户】接口响应流水号 |
||
verifyCode |
String |
是 |
短信验证码 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
respCode |
String |
是 |
业务码 |
返回校验处理成功、失败的业务码 |
respMsg |
String |
否 |
失败原因 |
【开户流水查询】接口
功能说明:
查询开户的基本信息、开户状态及开户结果
接口代码:4034
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
oriRespTraceNum |
String |
是 |
开户响应流水号 |
【企业实名开户】接口响应流水号 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
openAcctStatus |
String |
否 |
开户状态 |
SUCCESS:成功 FAIL:失败 PROCESSED:处理中(审核中) |
legpVerifyStatus |
否 |
企业开户-法人短验开户状态 |
(企业短验开户模式) 初始化:INIT 成功:SUCCESS 失败:FAIL 待短信认证:WAITSMSCONFIRM |
|
contactVerifyStatus |
否 |
企业开户-联系人短验开户状态 |
(企业短验开户模式) 初始化:INIT 成功:SUCCESS 失败:FAIL 待短信认证:WAITSMSCONFIRM |
|
smallPaymentStatus |
否 |
企业开户-小 |
需要小额打款验证时有效, |
|
authStatus |
企业开户-新 |
WAIT:待新网审核 SUCCE |
||
errorMsg |
否 |
开户失败原因 |
||
acctList |
否 |
电子台账数组 |
电子台账数组
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
acctNo |
String |
是 |
电子 |
|
acctType |
String |
是 |
电子 |
O_PWD:免密余额账簿 PEN |
【银行子账户实时余额查询】接口
功能说明:
接口查询子账户余额,返回总余额、可用金额、冻结金额、在途金额、可提现金额等信息;
接口代码:1060
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
请求流水号 |
|
signNum |
String |
是 |
商户会员编号 |
支持平台类账户查询,上送#yunBizUserId_B2C# |
subAcctNo |
String |
否 |
银行子账号 |
银行账户类型=14,必填 |
acctAttr |
String |
是 |
银行账户类型 |
针对中信银行,可上送如下: (1)银行为商户交易资金账户开立的公共登记簿标识、发起方输入标识进行查询: 00:公共计息收费登记薄 (2)用户登记簿标识: 14:子商户/用户登记薄 (3)平台剩余透支额度标识 RO_平台剩余透支额度 针对华通银行,必填,仅支持上送“14” 新网银行支持上送14 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
响应流水号 |
|
respCode |
String |
是 |
业务码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
否 |
失败原因 |
|
signNum |
String |
是 |
商户会员编号 |
|
avlBalance |
Long |
否 |
可用余额 |
单位:分 说明:中信银行、华通银行返回“可用余额” 新网银行返回 |
withdrawBalance |
Long |
否 |
可提现余额 |
单位:分 说明:中信银行返回 新网银行返回 |
balance |
Long |
否 |
总余额 |
单位:分 说明:华通银行返回 说明:华通银行总余额=冻结金额+可用余额 新网银行返回 |
frozenAmount |
Long |
否 |
冻结金额(不可用) |
单位:分 说明:华通银行返回 新网银行返回 |
transitAmount |
否 |
在途金额 |
新网银行返回 |
|
frozenTransitAmt |
否 |
冻结在途金额 |
单位:分 新网银行返回 |
|
frozenWithdrawAmt |
否 |
冻结可提现金额 |
单位:分 新网银行返回 |
|
splsOverBalance |
Long |
否 |
平台剩余透支金额 |
单位:分 仅上送“RO_平台剩余透支额度”返回 说明:中信银行返回 |
【银行子账户收支明细查询】接口
功能说明:
接口查询银行子账户的收支明细;
接口代码:1061
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
请求流水号 |
|
signNum |
String |
是 |
商户会员编号 |
|
subAcctNo |
String |
是 |
银行子账号 |
|
dateStart |
String |
是 |
查询日期(日期格式YYYYMMDD) |
开始日期和结束日期,时间间隔不大于3天; 中信银行,开始日期和结算日期必须相同 |
dateEnd |
String |
是 |
结束日期,YYYYMMDD |
|
qryTradeType |
String |
否 |
交易类型 |
新网银行,无需上送 |
returnRows |
String |
否 |
查询条数 |
中信银行固定50条 华通银行无需上送 |
page |
String |
否 |
页数 |
第一页查询:上送1,默认返回50条 华通银行无需上送 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
取值 |
respTraceNum |
String |
否 |
响应流水号 |
受理成功,则返回 |
respCode |
String |
是 |
返回码 |
00000:受理成功 |
respMsg |
String |
否 |
返回信息 |
|
signNum |
String |
是 |
商户会员编号 |
|
subAcctNo |
String |
是 |
银行子账号 |
|
totalPage |
String |
否 |
总页数 |
华通银行不返回 |
totalNum |
String |
否 |
记录总行数 |
查询成功,则返回 |
subAcctDetail |
List |
否 |
银行子账户收支明细 |
查询成功,则返回 |
银行子账户收支明细(subAcctDetail)
名称 |
说明 |
类型 |
取值 |
acctName |
用户名称 |
String |
|
chnlTradeCode |
银行交易流水号 |
String |
|
reqTraceNum |
业务订单号 |
String |
|
reqSubTraceNum |
业务子订单号 |
String |
|
tradeDate |
交易日期 |
String |
yyyyMMdd |
tradeTime |
交易时间 |
String |
HHmmss |
tradeType |
交易类型 |
String |
|
sysOrderNo |
系统流水号 |
String |
银行返回 |
fundDirection |
资金方向 |
String |
D:账户出金 C:账户入金 |
tradeAmount |
交易金额 |
String |
单位:分 |
oppAcctNo |
对手方账号 |
String |
入金返回 |
oppAcctName |
对手方户名 |
String |
入金返回 |
beforeBalance |
操作前余额 |
String |
单位:分 |
afterBalance |
操作后余额 |
String |
单位:分 |
summary |
摘要描述 |
String |
透传银行摘要 |
purpose |
用途 |
String |
用途 |
remark |
备注 |
String |
备注 |
postscript |
附言 |
String |
附言 |
tradeStatus |
交易状态 |
String |
正常:N, 充正:R, 被充正:X |
【银行用户新增绑卡申请】接口
功能说明:
支持银行在个人、企业会员开通银行子账户成功后新增绑定银行账户,云商通【银行卡管理】菜单不保存绑卡信息。
接口代码:1028
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
|
是 |
商户请求流水号 |
商户系统内保持唯一,定义长度为50位 |
signNum |
String |
|
是 |
商户会员编号 |
|
subAcctNo |
String |
|
是 |
银行子账号 |
|
bankAcctDetail |
JSONObject |
|
是 |
银行账户信息 |
详情,复用企业实名开户接口的银行账户对象 |
bankAcctExtInfo |
JSONObject |
|
否 |
银行绑卡申请(其他)信息 |
银行账户信息(bankAcctExtInfo)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
acctAttr |
String |
否 |
账户类型 |
对私(银行账户名称默认为法人姓名) 对公(银行账户名称默认为企业名称) 企业性质=企业/事业单位,默认1-对公,不支持上送0-对私; 企业性质=个体工商户,支持上送0-对私/1-对公,不填默认1-对公; |
acctNum |
String |
是 |
账号 |
账户类型=1-对公,企业对公账户,支持数字和“-”字符 账户类型=0-对私,则上送对私账户(借记卡) SM4加密,详细 |
bankReservePhone |
String |
否 |
银行预留手机 |
账户类型=0-对私,则必填 |
openBankNo |
String |
否 |
银行代码 |
对公:根据基础数据,上送“银行代码”字段,必填 对私:无需上送,系统自动根据卡BIN识别银行。 |
openBankBranchName |
String |
否 |
开户行支行名称 |
如:“中国工商银行股份有限公司北京樱桃园支行” 账户类型=1-对公,则必填 |
payBankNumber |
String |
否 |
支付行号,12位数字 |
账户类型=1-对公,则必填 |
openBankProvince |
String |
是 |
开户行所在省 |
开户行所在省 开户行所在市必须同时上送 根据中国省市表的“省份”内容填写。 |
openBankCity |
String |
是 |
开户行所在市 |
开户行所在市 开户行所在省必须同时上送 根据中国省市表的“城市”内容填写。 |
verifyCode |
String |
否 |
短信验证码 |
新网,必填 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
|
否 |
响应流水号 |
业务正常处理,则返回 |
respCode |
String |
|
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
|
是 |
失败原因 |
|
【查询会员信息】接口
功能说明:
(1)该接口支持查询个人会员、企业会员的会员信息。
(2)所有会员状态均支持查询会员信息。
(3)支持查询信息类型
(4)“查询信息类型”字段,支持多个枚举值通过逗号上送(兼容逗号的中英文),比如“1,2”/“2,3,4”,则返回对应查询信息;
信息类型 |
返回数据说明 |
1-基本信息 |
返回个人会员、企业会员基本信息 |
2-银行账户信息 |
返回个人会员(绑定状态=已绑定)的银行账户列表 返回企业会员(【企业会员实名开户】接口)设置的银行账户信息 |
3-协议信息 |
返回该会员签订的收款协议、账户提现协议、分账协议、授权委托书(所有签约状态的协议) |
4-影印件ocr核对信息 |
返回影印件识别比对结果 |
5-绑定手机信息 |
返回会员绑定的手机号 |
6-支付账户信息 |
返回会员支付账户信息 |
7-支付账户审核结果详情 |
返回会员支付账户审核结果详情 |
8-银行子账户信息 |
返回银行子账户信息(子账户、绑卡信息) |
9-待结算户信息 |
返回待结算户信息 |
接口代码:1027
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
请求流水号 |
|
signNum |
String |
60 |
是 |
商户会员编号 |
平台则上送“#yunBizUserId_B2C” |
infoType |
String |
1 |
是 |
查询信息类型 |
1-基本信息 2-银行账户信息 3-协议信息 4-影印件ocr核对信息 5-绑定手机号信息 6-支付账户信息 7-支付账户审核结果详情 8-银行子账户信息 9-待结算户信息 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
否 |
响应流水号 |
业务正常处理,则返回 |
respCode |
String |
5 |
是 |
业务码 |
|
respMsg |
String |
200 |
否 |
失败原因 |
|
signNum |
String |
60 |
否 |
商户会员编号 |
|
memberBasicInfo |
JSONObject |
否 |
会员基本信息 |
||
acctInfo |
JSONArray |
否 |
银行账户信息 |
支持返回多个银行账户信息 |
|
agreementArray |
JSONArray |
否 |
协议信息 |
||
ocrResultJson |
JSONObject |
否 |
影印件OCR核对结果 |
||
bindPhoneJson |
JSONObject |
否 |
绑定手机号信息 |
||
payAcctOpenJson |
JSONArray |
否 |
支付账户开户信息 |
||
payAcctAuditJson |
JSONObject |
否 |
支付账户审核结果详情 |
||
bankSubAcctInfo |
JSONArray |
否 |
银行子账户信息 |
||
settleAcctInfo |
JSONObject |
否 |
待结算户信息 |
银行子账户信息(bankSubAcctInfo)
字段 |
字段类型 |
必填 |
字段名 |
说明 |
openBankNo |
String |
是 |
开户银行编码 |
新网银行: |
subAcctNo |
String |
是 |
银行子账号 |
开户成功,则返回 |
subAcctStatus |
String |
是 |
银行子账户状态 |
未激活 正常 已注销 |
acctType |
String |
否 |
银行子账户类型 |
01:普通账户 02:佣金账户 03:待结算户 04:免密余额户 |
openAcctTime |
String |
是 |
开户时间 |
开户成功,则返回 格式:202404251647 |
cardList |
List |
否 |
银行绑卡信息 |
|
银行绑卡信息
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
cardNo |
String |
是 |
银行卡号 |
明文返回 |
bindingAcctBa nkCode |
否 |
绑定账户开户行行号 |
新网银行返回 |
|
bindingAcctBa nkName |
否 |
绑定账户开户行行名 |
新网银行返回 |
|
bindingAcctNa me |
否 |
绑定账户名称 |
新网银行返回 |
|
bindingAcctTy pe |
否 |
绑定卡类型 借记卡: DEBIT, 贷记卡: CREDIT, 对公账户: PUBLIC |
绑定卡类型 借记卡: DEBIT, 贷记卡: CREDIT, 对公账户: PUBLIC 新网银行返回 |
|
bindState |
String |
是 |
卡状态 |
1:已绑定 0:未绑定 2: 已解绑 3:已冻结(账号暂不可用) |
【分账申请授权和确认】接口
接口说明:支持新网银行完成自定义结算授权申请和确认。
接口代码:4036
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
|
是 |
请求流水号 |
|
signNum |
String |
|
是 |
商户会员编号 |
#yunBizUserId_B2C# |
subAcctNo |
String |
|
是 |
银行子账号 |
|
opType |
String |
|
是 |
操作类型 |
授权申请SETTLE_AUTH_AP 授权确认SETTLE_AUTH_CONFIRM |
verifyCode |
String |
|
否 |
短信验证码 |
SETTLE_AUTH_CONFIRM时 |
orderMaxAmount |
Long |
|
否 |
授权单笔最大 |
单位:分,opt |
dayMaxAmount |
Long |
|
否 |
授权单日最大 |
单位:分,opt |
beginDate |
String |
|
否 |
授权 |
yyyyMMdd,opt_type=SE |
endDate |
String |
否 |
授权 |
yyyyMMdd,opt_type=SE |
|
remark |
String |
否 |
备注 |
备注 |
|
authType |
String |
是 |
授权类型 |
一次性授权:1 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
respTraceNum |
String |
否 |
响应流水号 |
|
respCode |
String |
是 |
业务码 |
|
respMsg |
String |
否 |
失败原因 |
|
authCode |
String |
否 |
授权ID |
交易类接口
商户业务系统需将业务订单与支付订单(云商通)以分层的方式处理,即在业务订单需支付时才向云商通请求订单申请
(1) 可实现业务系统商品订单用户支付失败时,可以再次对商品订单发起支付;
(2) 可实现业务系统商品订单的自定义有效期;云商通未支付的订单,每天日终(00:30)批量关闭已创建未支付,且创建时间大于24小时的订单。
(3) 可实现业务系统商品订单多次多笔支付。
(4) 避免渠道端因支付时效控制关闭支付订单后,影响原业务订单的支付。
业务场景 |
商户系统 |
云商通 |
1笔业务订单全部支付 |
业务订单号 |
商户订单号(reqTraceNum) |
1笔业务订单多次部分支付 |
业务订单号 |
商户订单号1(reqTraceNum) 商户订单号2(reqTraceNum) 商户订单号3(reqTraceNum) |
多笔业务订单合并支付(多收款人) |
业务订单号1 业务订单号2 业务订单号3 。。。 |
商户订单号(reqTraceNum) |
【消费申请】
功能说明:
- 账户产品:消费仅支持上送一个收款人,收款方及分账方需满足角色及协议签订要求
(1)收款会员仅支持簿记账户(会员状态=有效)收款,分账会员仅支持簿记账户(会员状态=有效)。
(2)针对“POS及当面付、付款码支付”等线下支付模式,可以不上送付款方会员相关字段
(3)银行卡协议支付:付款会员需先注册;非银行卡协议支付:付款会员无需注册但接口需商户付款方会员相关信息。
(4)订单类型“消费”,对应订单子类型为“消费”;
接口代码:2085
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
signNum |
String |
60 |
否 |
商户会员编号-付款人 |
商户系统用户唯一标识 银行卡协议支付:付款会员需先注册 非银行卡协议支付:付款会员无需注册 |
receiverSignNum |
String |
60 |
否 |
商户会员编号-收款人 |
商户系统用户唯一标识 支持个人会员、企业会员,不支持平台会员(平台会员不设置角色),若“平台会员”固定上“#yunBizUserId_B2C#” |
platAcctType |
String |
2 |
否 |
平台账户类型 |
“receiverSignNum”为平台会员时,必填; 09:应用储值卡账户(非“账后结算”资金管理模式) 10:储值卡待结算户(“账户结算”资金管理模式) |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
orderAmount |
Long |
20 |
是 |
订单金额 |
单位:分 订单金额=支付金额+营销金额 |
payAmount |
Long |
20 |
否 |
支付金额 |
单位:分 渠道实际需支付金额 不上送时,则“营销金额”必送,即:订单金额=营销金额; |
promotionAmount |
Long |
20 |
否 |
营销金额 |
单位:分 平台承担的营销金额 |
couponAmount |
Long |
20 |
否 |
平台抽佣金额 |
单位:分 仅上送“收款会员编号”时有效; |
payMode |
JSONObject |
256 |
否 |
支付模式 |
详见支付模式字典 注“支付金额”为空或0时,可不送 |
sepDetail |
JSONArray |
否 |
分账规则 |
分账规则列表 |
|
reqsUrl |
String |
256 |
否 |
前台通知地址 |
|
respUrl |
String |
256 |
是 |
后台通知地址 |
|
orderValidTime |
String |
20 |
否 |
订单过期时间 |
|
goodsName |
String |
50 |
否 |
商品名称 |
如下支付模式必填: 1.快捷支付 2.H5收银台 3.微信小程序收银台 4.支付宝小程序收银台 |
goodsDesc |
String |
256 |
否 |
商品描述 |
|
summary |
String |
100 |
否 |
摘要 |
|
String |
200 |
否 |
扩展参数 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
否 |
订单状态 |
订单成功时会发订单结果通知商户。 |
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
extendParams |
String |
200 |
否 |
扩展参数 |
|
channelParamInfo |
JSONObject |
否 |
渠道参数信息(支付详情) |
渠道返回时有值 |
|
chnlFrontParamInfo |
JSONObject |
否 |
渠道参数信息(前端支付参数) |
渠道返回时有值 (1)扫码支付信息/ JS支付串信息(微信、支付宝、QQ钱包) (2)交易验证方式(收银宝快捷) (3)收银宝小程序收银台支付参数(innappid) (4)收银宝手机安全控件支付参数(innappid) |
|
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
【退款申请】
功能说明:
支持消费申请、担保消费申请(已支付确认、未支付确认)、转账订单(仅支持平台转账退款)发起退款,支持1年内的订单发起退款。
退款情况说明:
(1)发起退款时,请确保退款账户(原订单的收款人账户)中有足够的可用余额;
(2)支持全额退款、部分金额退款,退款金额不得超过原订单金额;
(3)退款资金原路返回;
(4)原订单中含营销账户金额,
- 上送营销退款金额,则原路返回;
- 不上送营销退款金额,则退款金额不能大于原订单的支付金额”,即退款金额=“原订单金额-营销金额”;
(5) 原订单中含抽佣金额
A-不退“平台抽佣金额”:退款总金额需小于等于原订单的“订单金额”-“平台抽佣金额”的值;
- 退“平台抽佣金额”:退款总金额需小于等于原支付订单的订单金额,退款时平台抽佣退款金额需小于等于原支付订单的平台抽佣金额;
(6)原订单有分账,支持分账金额全额退款、部分退款:
- 不上送分账退款金额,则收款人退款金额不能大于“收款金额-分账金额”;
- 上送分账退款金额:分账退款金额不能大于分账金额;分账资金从分账收款人到收款人,再从收款人到付款人,最后原路退回(外部渠道或应用营销账户);
(7)“是否需要调拨资金”字段,当上送“1:是”,系统自动从收付通调拨退款资金到收银宝用于退款的功能,无论资金调拨是否成功均会向收银宝发起订单退款并响应“资金退款调拨状态”、“调拨金额”。
- 仅“通联管理”支持调拨资金;调拨资金后,先查询收银宝余额足够则发起退款申请,余额不足则最多查询3次后,调用收银宝【交易退款】接口完成退款。
- 调拨资金时,会影响收付通资金变动,为了避免提现时因收付通余额不足而导致提现失败,需根据收银宝余额真实情况,谨慎上送此字段。
接口代码:2294
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号-退款订单号 |
|
orgRespTraceNum |
String |
40 |
是 |
原通联订单号 |
原消费、担保消费、平台转账订单 |
orderAmount |
Long |
20 |
是 |
退款总金额 |
单位:分。 1.【消费申请】退款, 上送退款列表:退款总金额=订单退款列表中(退款金额)之和; 不上送退款列表:退款总金额,不能大于原订单金额-平台抽佣金额-分账金额 2.【担保消费申请】退款:退款总金额=订单退款列表中(退款金额)之和; 3. 【转账申请】退款,“退款总金额”不能大于转账金额。 |
promotionAmount |
Long |
20 |
否 |
营销退款金额 |
单位:分 1.不能超过退款总金额; 2.不能超过原订单营销金额; 3.支持部分退款。 4.如不填,则不退营销退款金额,则“退款总金额”不能超过“原订单的订单金额-营销金额” |
refundDetail |
JSONArray |
否 |
订单退款列表 |
1.【消费申请】退款: (1)需要“平台抽佣退款或订单分账退款”时,需上送(仅支持1个列表); (2)不上送时,则不退款平台抽佣及分账退款资金;退款总金额不能大于“原订单订单金额-分账金额-平台抽佣金额” 2.【担保消费申请】退款,必填; A.未担保确认:从应用担保户退款 B.已担保确认:从收款人簿记账户退款; 3.【转账申请】退款,不用上送 |
|
isFundAllocation |
String |
1 |
否 |
是否需要调拨资金 |
0:否 1:是 注:默认“0:否”; 仅“通联存管”支持上送“1:是”,上送“1”,则从收付通将资金调拨回收银宝,实现退款。 |
respUrl |
String |
256 |
是 |
后台通知地址 |
如果不填,则不通知。 退款成功时,才会通知 |
chnlDiscAmt |
JSONObject |
否 |
优惠信息 |
此字段只适用于银联云闪付单品优惠交易的退货,含单品优惠交易只能整单退款,不支持部分退款 |
|
extendParams |
String |
200 |
否 |
扩展信息 |
接口将原样返回,不可包含“|”及换行符+,空格,/,?,%,#,&,=等特殊字符,最多100个字符 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
否 |
订单状态 |
订单成功时会发订单结果通知商户。 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
extendParams |
String |
200 |
否 |
扩展信息 |
接口将原样返回,最多50个字符,不可包含“|”特殊字符 |
channelParamInfo |
JSONObject |
否 |
渠道参数信息 |
渠道返回时有值 |
|
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
【订单关闭】
功能说明:
- 出金订单(提现):支持关闭未发往渠道订单(含未支付、进行中);
- 入金订单(消费、担保消费申请):支持关闭支付模式为“微信正扫、支付宝正扫、微信小程序、微信公众号、支付宝JS、微信小程序收银台、支付宝小程序收银台、微企付”未付款成功订单
- 测试环境:不支持订单关闭
接口代码:2295
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
orgRespTraceNum |
String |
40 |
是 |
原通联订单号 |
若“商户订单号”和“通联订单号”均上送,以“通联订单号”查询 |
closeReason |
String |
100 |
否 |
关单原因 |
微企付必填 |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
closeResult |
Long |
1 |
是 |
订单关闭结果 |
1-关闭成功 2-关闭失败 |
closeFinishTime |
String |
20 |
否 |
订单关闭完成时间 |
订单关闭成功时,返回 |
result |
String |
1 |
否 |
订单状态 |
订单成功时会发订单结果通知商户。 |
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
【确认支付(后台+短信验证码确认)】
功能说明:
1、对消费、担保消费交易进行确认支付验证。
2、最多支持输入错误10次(含跨天)。
3、验证次数超限后订单不支持确认处理;订单状态“未支付”, 报错:errorCode=20011&message=验证码错误次数超过限制。
接口代码:3010
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
verifyCode |
String |
6 |
是 |
短信验证码 |
业务响应参数
字段 |
字段类型 |
字段类型 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
否 |
订单状态 |
订单成功时会发订单结果通知商户。 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
【订单入金确认】
功能说明:
1、针对新网银行,订单入金通知的交易,由商户通过此接口确认是否做订单入金。
接口代码:4035
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
|
是 |
请求流水号 |
|
oriRespTraceNum |
String |
|
是 |
通联订单号 |
待确认的通联订单号 |
confirmResult |
String |
|
是 |
确认结果 |
SUCCESS:成功 FAIL:失败 |
remark |
String |
|
否 |
确认结果说明 |
业务响应参数
字段 |
字段类型 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
|
否 |
响应流水号 |
业务正常处理,则返回 |
respCode |
String |
|
是 |
业务返回码 |
|
respMsg |
String |
|
是 |
失败原因 |
如:订单已终态,不可重复确认! |
【银行子账户支付接口】
接口说明:
1.商户业务订单号+商户业务子订单号应保证唯一。
2.当“平台商户自有资金交易类型”为C时,交易金额=收款用户收款金额+平台商户自有资金交易金额;
3.当“平台商户自有资金交易类型”为D时,交易金额+平台商户自有资金交易金额=收款用户收款金额;
4.平台商户自有资金交易类型”字段,上送“N:无资金动账”:“tradeAmount-交易金额”等于“receiveAmount-收款用户收款金额”;
5.订单子账户支付,无异步通知,接口实时响应。
接口代码:2081
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
商户业务订单号 |
该笔业务订单由平台商户端生成的业务订单号
|
payerSignNum |
String |
是 |
付款商户会员编号(资金转出方) |
|
payerSubAcctNo |
String |
是 |
付款商户银行子账号 |
上送银行用户编号 |
payerName |
String |
是 |
付款商户会员名称(资金转出方) |
|
receiverList |
JSONArray |
否 |
收款商户信息列表 |
若上送,必须同时上送 说明:收款总金额等于列表中收款金额总和 若平台会员编号,上送#yunBizUserId_B2C# |
totalAmount |
Long |
否 |
收款用户收款总金额,单位:分 |
|
receiverSignNum |
String |
否 |
收款商户会员编号(资金转入方) |
若平台会员编号,上送#yunBizUserId_B2C 四个字段信息若上送,必须同时上送 说明:收款商户用户信息与列表信息,仅可以二选一 |
receiverSubAcctNo |
String |
否 |
收款商户银行子账号 |
|
receiverName |
String |
否 |
收款商户会员名称(资金转入方) |
|
receiveAmount |
Long |
否 |
收款用户收款金额,单位:分 |
|
tradeAmount |
Long |
是 |
交易金额,单位分 |
|
selfFlag |
String |
是 |
平台商户自有资金交易类型 |
D:平台优惠 C:平台分成 N:无资金动账 当“平台商户自有资金交易类型”为C时,交易金额=收款用户收款金额+平台商户自有资金交易金额 当“平台商户自有资金交易类型”为D时,交易金额+平台商户自有资金交易金额=收款用户收款金额 新网银行,仅支持上送C:平台分成 |
selfAmount |
Long |
是 |
平台商户自有资金交易金额,单位:分 |
例如:89.00元,金额不能为负数。 P_ SELF_FLAG为C时,应小于交易金额。 P_ SELF_FLAG为N时,该字段金额应为0.00 |
fundType |
String |
否 |
资金类型/商品信息 |
|
remark |
String |
否 |
备注 |
|
extendParams |
String |
否 |
拓展参数 |
JSON格式 {“authId”:“88888888888”} |
收款用户列表(请求)
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
receiverSignNum |
String |
否 |
收款商户会员编号(资金转入方) |
若平台会员编号,上送#yunBizUserId_B2C#
|
receiverSubAcctNo |
String |
是 |
收款商户银行子账号 |
|
receiverName |
String |
否 |
收款商户会员名称(资金转入方) |
|
receiveAmount |
Long |
是 |
收款用户收款金额,单位:分 |
|
platSepTraceNum |
String |
是 |
平台分账 |
响应请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
result |
String |
否 |
订单状态 |
进行中 交易成功 交易失败 |
respTraceNum |
String |
是 |
通联订单号 |
|
reqTraceNum |
String |
是 |
商户订单号(支付订单) |
|
chnlTradeCode |
String |
否 |
银行侧交易流水号 |
chnlTradeCode返回新网银行“好惠通流水号”
|
chnlTradeDate |
String |
否 |
银行侧交易日期 |
|
chnlTradeTime |
String |
否 |
银行侧交易时间 |
|
respCode |
String |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
否 |
业务返回说明 |
|
receiverList |
JSONArray |
否 |
收款用户信息列表 |
收款用户列表(响应)
字段 |
字段类型 |
必填 |
字段名称 |
receiverSignNum |
String |
是 |
收款商户会员编号(资金转入方) |
receiverSubAcctNo |
String |
是 |
收款商户银行子账号 |
receiverName |
String |
否 |
收款商户会员名称(资金转入方) |
receiveAmount |
Long |
是 |
收款用户收款金额,单位:分 |
platSepTraceNum |
String |
是 |
平台分账流水号 |
bankSepTraceNum |
String |
是 |
银行侧分账流水号 |
【银行子账户提现】接口
接口说明:
新增新网银行,支持子账户出金;
接口代码:2292
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
signNum |
String |
是 |
商户会员编号 |
支持平台提现,上送#yunBizUserId_B2C# 新网银行不支持平台提现 |
subAcctNo |
String |
否 |
银行子账号 |
只有平台提现,才可以非必填 |
reqTraceNum |
String |
是 |
商户订单号 |
全局唯一,不可重复 不可包含“|”字符 |
tradeAmount |
Long |
是 |
订单金额 |
单位:分 |
couponAmount |
Long |
否 |
抽佣金额(手续费) |
单位:分 新网银行,支持上送 |
withdrawType |
String |
否 |
提现方式 |
提现方式,T0:T0提现(当日到账) T1:T1提现 新网银行,支持上送 |
respUrl |
String |
是 |
后台通知地址 |
|
payMode |
String |
是 |
支付模式 |
固定:WITHDRAW_BANK |
acctNum |
String |
是 |
银行卡号 |
|
showPayerAcctNo |
String |
否 |
显示付款账号 |
华通银行若填,必须为发起交易的记账簿账户号码,否则交易失败 华通银行支持上送 |
showPayerAcctName |
String |
否 |
显示付款户名 |
华通银行若填,必须为发起交易的记账簿账户户名,否则交易失败 华通银行支持上送 |
acctName |
String |
否 |
账户名 |
上送,则校验【银行卡管理】菜单银行卡记录是否存在: 存在:校验“银行账户名”是否一致; 不存在:则透传银行;
不上送,则校验银行卡是否存在, 存在:则取【银行卡管理】菜单“银行账户名”上送; 不存在:则要求必填; |
summary |
String |
否 |
摘要 |
|
extendParams |
String |
否 |
扩展信息 |
原样返回 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
result |
String |
否 |
订单状态 |
|
respTraceNum |
String |
是 |
通联订单号 |
|
reqTraceNum |
String |
是 |
商户订单号(支付订单) |
|
chnlTradeCode |
String |
否 |
银行交易流水号 |
透传“中信银行流水号” |
extendParams |
String |
否 |
扩展信息 |
|
respCode |
String |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
是 |
业务返回说明 |
|
【银行子账户支付退款】接口
功能说明:
针对新网银行:原“银行子账户支付”交易无论上送的是“收款用户信息”还是“收款用户列表”,仅支持按照每个收款用户和其收款金额进行退款(支持部分多次退款)。“平台商户自有资金交易金额”不支持退款;
接口代码:2291
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
是 |
退款订单号 |
该笔业务订单由平台商户端生成的业务订单号 |
reqSubTraceNum |
String |
否 |
退款子订单号 |
该笔业务订单下每笔业务子订单由平台商户端生成的唯一标识 商户业务订单号+商户业务子订单号应保证唯一。 新网银行,无需上送 |
oriRespTraceNum |
String |
是 |
原通联订单号 |
|
receiverSignNum |
String |
是 |
原支付交易付款用户编号(资金转入方) |
原收款用户信息 若平台会员编号,上送#yunBizUserId_B2C# |
receiverSubAcctNo |
String |
是 |
原支付交易付款用户银行子账号 |
上送银行用户编号 |
receiverName |
String |
是 |
原支付交易付款用户名称(资金转入方) |
|
payerSignNum |
String |
是 |
原支付交易收款用户编号(资金转出方) |
|
payerSubAcctNo |
String |
是 |
原支付交易收款用户银行子账号 |
上送银行用户编号 |
payerName |
String |
是 |
原支付交易收款用户名称(资金转出方) |
|
receiveAmount |
Long |
是 |
原支付交易收款用户退款金额,单位:分 |
为原支付交易收款用户退款金额 |
tradeAmount |
Long |
是 |
交易金额,单位:分 |
为原支付付款用户退款金额 |
selfFlag |
String |
是 |
平台商户自有资金交易类型 |
N:无资金动账 D:扣平台自有资金登记薄 C:入平台自有资金登记薄 如不为N,应与原支付交易资金方向相反,即原支付交易该字段为D,退款交易该字段应为C。 当原支付交易“平台商户自有资金交易类型”为C时(退款交易该字段送D),交易金额=原支付交易收款用户退款金额+平台商户自有资金退款金额 当原支付交易“平台商户自有资金交易类型”为D时(退款交易该字段送C),交易金额+平台商户自有资金退款金额=原支付交易收款用户退款金额 华通银行,此字段仅上送“N:无资金动账” 新网银行,此字段仅支持上送“N:无资金动账” |
selfAmount |
Long |
是 |
平台商户自有资金退款金额,单位:分 |
P_ SELF _FLAG为N时,该字段应为0 “中信银行托管”,必填; 华通银行,上送0; |
fundType |
String |
否 |
资金类型/商品名称 |
|
remark |
String |
否 |
备注 |
|
响应请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
否 |
通联订单号 |
必填字段校验均通过,返回此字段 |
chnlTradeCode |
String |
否 |
银行侧交易流水号 |
业务返回码=00000,返回 |
chnlTradeDate |
String |
否 |
银行侧交易日期 |
|
chnlTradeTime |
String |
否 |
银行侧交易时间 |
|
respCode |
String |
是 |
业务返回码 |
00000:代表成功 66666、66667:处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 其他返回码:均代表失败 |
respMsg |
String |
否 |
业务返回说明 |
|
【订单入金退款】接口
功能说明:
新增【订单入金退款】接口,支持对新网银行,订单入金的充值订单进行退款。
接口代码:2097
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
reqTraceNum |
String |
是 |
商户订单号-退款订单号 |
oriRespTraceNum |
String |
是 |
原通联订单号 |
bankRefundAmt |
Long |
是 |
银行侧退款金额 |
reason |
String |
否 |
退款原因 |
summary |
String |
否 |
摘要 |
业务响应参数
字段 |
字段类型 |
必填 |
字段名称 |
result |
String |
否 |
订单状态 |
respMsg |
String |
否 |
订单失败信息 |
reqTraceNum |
String |
是 |
商户订单号 |
respTraceNum |
String |
是 |
通联订单号 |
respCode |
String |
是 |
业务返回码 |
respMsg |
String |
是 |
业务返回说明 |
【订单结果通知】
功能说明:
- 通知地址是商户在创建订单时提供的“respUrl-后台通知地址”地址;
- 订单成功、订单失败都会发送异步通知;
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
result |
String |
1 |
是 |
订单状态 |
订单成功和失败时都会通知商户 |
respMsg |
String |
200 |
否 |
错误信息 |
订单状态“交易失败”时,有值 |
reqTraceNum |
String |
50 |
是 |
商户订单号(支付订单) |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
orgRespTraceNum |
String |
40 |
否 |
原云商通订单号 |
退款订单该字段才返回 |
orgReqTraceNum |
String |
50 |
否 |
原商户订单号 |
退款订单该字段才返回 |
orderAmount |
Long |
20 |
是 |
订单金额 |
单位:分 |
finishTime |
String |
20 |
否 |
订单支付完成时间 |
云商通订单支付完成时间 yyyy-MM-dd HH:mm:ss |
signNum |
String |
60 |
否 |
商户会员编号-付款人 |
|
receiverSignNum |
String |
60 |
否 |
商户会员编号-收款人 |
仅消费和转账 |
transferResult |
String |
1 |
否 |
退款资金调拨结果 |
0:调拨失败 1:调拨成功 注:仅【退款申请】接口: “isFundAllocation-是否需要资金调拨”字段,上送值为“1:是”且原订单为“收银宝渠道”退款的情况下做如下返回: (1)“1:调拨成功”-收付通资金调拨收银宝成功 (2)“0:调拨失败”-收付通金调拨收银宝失败 |
transferAmount |
Long |
200 |
否 |
调拨金额 |
单位:分 |
extendParams |
String |
200 |
否 |
扩展参数 |
接口将原样返回,不可包含“|”特殊字符 |
channelParamInfo |
JSONObject |
否 |
渠道参数信息(支付详情) |
渠道返回时有值 |
【划款入账通知】
功能说明:
- 通知地址需在云商通预留,由分公司对口在管理平台配置;
- 云商通接收到银行的入金通知后,向平台预留的通知接收地址发起通知。
- 针对新网银行【订单入金通知】场景,发送通知给商户后,需商户调用【订单入金确认】接口完成确认。
接口代码:2080
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
openBankNo |
String |
4 |
否 |
开户银行编码 |
银行存管模式,返回 1024:新网银行 |
chnlTradeCode |
String |
50 |
是 |
渠道流水号 |
渠道端流水号 |
reqTraceNum |
String |
50 |
否 |
商户订单号 |
“商户订单号”值赋值为“渠道流水号” 说明:针对“7:应用银行账户”场景,入账失败自动退款场景,无值 |
respTraceNum |
String |
40 |
否 |
通联订单号 |
说明:针对“7:应用银行账户”场景,入账失败自动退款场景,无值 |
payAcctNo |
String |
32 |
是 |
来款账号 |
打款付款方账号 |
payAcctName |
String |
32 |
否 |
来款账户名 |
打款付款方账户名 仅“UCP”渠道有值 |
receiveAcctType |
String |
1 |
是 |
入账账户类型 |
1:簿记账户 2:支付账户 3:待结算户 4:储值卡待结算户 5:应用营销账户 6:应用储值卡账户 7:应用银行账户 |
signNum |
String |
60 |
是 |
入账商户会员编号 |
若为“#yunBizUserId_B2C#”,则表示平台上账; 说明:针对“7:应用银行账户”场景,入账失败自动退款场景,无值 |
inAcctNo |
String |
32 |
否 |
入账账号 |
|
inAcctName |
String |
32 |
否 |
入账会员名称 |
入账会员户名 |
orderAmount |
Long |
20 |
是 |
入账金额 |
汇入金额 单位:分 |
transDateTime |
String |
20 |
是 |
入账时间 |
YYYY-MM-DD hh:mm:ss |
result |
Long |
1 |
是 |
入账状态 |
1:入账成功 2:入账失败 5:待入金确认 |
message |
String |
200 |
否 |
入账失败说明 |
入账失败说明 |
summary |
String |
100 |
否 |
交易附言 |
渠道附言 |
remark |
String |
100 |
否 |
备注 |
备注 |
【退汇异步通知】
功能说明:
- 云商通接收到银行的退汇通知后,向平台发起通知。
接口代码:2296
业务请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
signNum |
String |
是 |
商户系统用户标识,商户系统中唯一编号。 |
原订单会员 |
acctType |
String |
是 |
|
账户类型,见账户类型字典 1:薄记账户 2:银行子账户 |
reqTraceNum |
|
是 |
商户订单号 |
生成退票订单时,云商通系统生成商户订单号 |
respTraceNum |
String |
是 |
通联订单号 |
|
refundStatus |
String |
是 |
退票状态 |
1-交易成功 2-交易失败 |
orgReqTraceNum |
String |
是 |
原商户订单号 |
发生退票的原商户订单号 |
orgRespTraceNum |
String |
是 |
原通联订单号 |
发生退票的原通联订单号 |
orderAmount |
Long |
是 |
订单金额 |
退票金额,单位:分 |
couponAmount |
Long |
是 |
平台抽佣金额 |
|
finishTime |
String |
是 |
退票完成时间 |
yyyy-MM-dd HH:mm:ss |
refundReason |
String |
否 |
退票原因 |
交易结果查询类
【订单状态查询】
功能说明:
针对商户订单未终态订单,支持调用此接口查询订单状态,作为未收到异步通知的保障机制,支持查询1年内的订单状态
接口代码:3001
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
否 |
通联订单号 |
1.“通联订单号”与“商户订单号+订单创建日期”,必传其中一种 2.使用“商户订单号”查询时,必须传“订单创建日期”。 为确保订单查询效率,建议使用通联单号 |
reqTraceNum |
String |
50 |
否 |
商户订单号 |
|
oriTransDate |
String |
8 |
否 |
订单创建日期 格式:yyyyMMdd |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
result |
String |
1 |
否 |
订单状态 |
|
orderAmount |
Long |
20 |
是 |
订单金额 |
|
payAmount |
Long |
20 |
否 |
支付金额 |
|
finishTime |
String |
20 |
否 |
订单支付完成时间 |
订单终态时,有值 |
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
【订单详情查询】
功能说明:
商户通过【订单状态查询接口】获取订单终态后,需通过已完成订单的交易信息作下一步业务判断时,可调用此接口查询订单详细信息,支持查询5年内的订单详情信息。
接口代码:3002
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
respTraceNum |
String |
40 |
否 |
通联订单号 |
1.“通联订单号”与“商户订单号+订单创建日期”,必传其中一种 2.使用“商户订单号”查询时,必须传“订单创建日期”。 为确保订单查询效率,建议使用通联单号 |
reqTraceNum |
String |
50 |
否 |
商户订单号 |
|
oriTransDate |
String |
8 |
否 |
订单创建日期 格式:yyyyMMdd |
业务响应参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
reqTraceNum |
String |
50 |
是 |
商户订单号 |
|
respTraceNum |
String |
40 |
是 |
通联订单号 |
|
result |
String |
1 |
否 |
订单状态 |
|
orgReqTraceNum |
String |
50 |
否 |
云商通原订单号 |
退款时才返回 |
orgRespTraceNum |
String |
40 |
否 |
原商户订单号 |
退款时才返回 |
orderAmount |
Long |
20 |
是 |
订单金额 |
|
payAmount |
Long |
20 |
否 |
支付金额 |
|
finishTime |
String |
20 |
否 |
订单支付完成时间 |
yyyy-MM-dd HH:mm:ss |
signNum |
String |
60 |
是 |
商户会员编号-付款人 |
|
extendParams |
String |
200 |
否 |
扩展参数 |
订单接口信息原样返回,不可包含“|”特殊字符 |
channelParamInfo |
JSONObject |
否 |
渠道参数信息(支付详情) |
渠道返回时有值 |
|
respCode |
String |
5 |
是 |
业务返回码 |
|
respMsg |
String |
200 |
是 |
业务返回说明 |
对账文件下载类接口
【应用集合对账文件下载】
功能说明:
- 接口用于平台从云商通系统获取对账文件,供平台进行对账,建议早上9:30后下载;
- 对账内容包含所有成功订单;
- 对账文件名称:yyyy-mm-dd商户对账文件.txt
明细对账文件格式:通联订单号|订单类型|交易金额(单位:分)|平台抽佣金额(单位:分)|交易时间|商户订单号|原商户订单号|原通联订单号|支付模式|扩展参数|结算金额|预留字段1|预留字段2|预留字段3|渠道金额|渠道流水号|渠道手续费(单位:分)|渠道交易类型|卡号|卡类别|
- Excel对账单文件名称格式:yyyy-mm-dd商户对账文件.xlsx
- 通联订单号:通联生成唯一订单号。
- 订单类型:详见订单类型的枚举值。
- 交易金额:单位:分;
- 平台抽佣金额:单位:分,平台通过订单的 “couponAmount”字段向会员收取的抽佣金额,资金入平台簿记账户,如果为空,该字段默认显示为0,而不是空串;
- 交易时间:yyyy-MM-dd HH:mm:ss,订单支付完成时间;
- 商户订单号:商户通过订单上送的“商户订单号”;
- 原商户订单号:针对退款订单/提现退票订单,返回原商户订单号;单订单担保确认、单会员担保确认、批量分账的订单,返回原商户订单号;
- 原通联订单号:针对退款订单/提现退票订单,返回原通联订单号;单订单担保确认、单会员担保确认、批量分账的订单,返回原商户订单号;
- 支付模式:订单的支付模式,对应【支付模式】;
- 扩展参数:订单申请上送的“扩展参数-extendParams”信息,原样透传返回给商户;
- 结算金额:通过【消费申请】的交易,该笔交易的结算金额;
- 预留字段1:目前默认为空,以便后续扩展;
- 预留字段2:目前默认为空,以便后续扩展;
- 预留字段3:目前默认为空,以便后续扩展;
- 渠道金额:单位:分,从支付渠道对账文件获取的支付渠道金额,仅透传信息,如果为空,该字段默认显示为0,而不是空串。
- 渠道流水号:从支付渠道对账文件获取的渠道流水号,仅透传信息,如果为空,该字段默认显示为0,而不是空串。
- 渠道手续费:单位:分,从支付渠道对账文件获取的支付交易手续费,仅透传信息,如果为空,该字段默认显示为0,而不是空串。
- 渠道交易类型:透传渠道实际交易类型,针对收银宝入金交易返回;
- 卡号:透传渠道返回的用户交易使用的卡号信息,其中银行卡返回卡号带掩码格式,微信支付返回用户openid,支付宝支付返回用户userid;
- 卡类别:透传渠道返回的用户交易使用的卡种;
业务请求参数
字段 |
字段类型 |
字段长度 |
必填 |
字段名称 |
说明 |
fileDate |
String |
8 |
是 |
对账文件日期 |
YYYYMMDD |
fileType |
String |
2 |
是 |
文件类型 |
1:txt文件 2:excel文件 3:银行余额对账文件 |
业务响应参数
- 成功下载直接返回文件流;
- 失败的情况返回错误信息错误码,竖线分割。例如:0001|文件不存在