目录
1.1公共请求参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
appId |
String |
是 |
云商通二代分配的应用ID |
如上送服务商应用ID,验证服务商证书 |
spAppId |
String |
否 |
云商通二代分配的服务商应用ID |
|
transCode |
String |
是 |
接口代码 |
|
format |
String |
否 |
仅支持JSON |
json |
charset |
String |
是 |
请求使用的编码格式,utf-8 |
UTF-8 |
signType |
String |
是 |
商户生成签名字符串所使用的签名 算法类型 |
比如:SM3withSM2 |
sign |
String |
是 |
商户请求参数的签名串 |
|
transDate |
String |
是 |
发送请求的日期,格式"yyyyMMdd" |
20240202 |
transTime |
String |
是 |
请求时间 |
141333 |
version |
String |
是 |
调用的接口版本 |
1.0 |
bizData |
String |
是 |
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
1.2公共响应参数
字段 |
字段类型 |
必填 |
字段名称 |
说明 |
code |
String |
是 |
调用结果返回码 |
00000-成功 |
msg |
String |
是 |
调用结果返回码描述 |
|
sign |
String |
是 |
商户请求参数的签名串 |
|
bizData |
String |
是 |
返回参数的集合,最大长度不限,除公共参数外所有返回参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
1.3 异步通知公共参数
字段 |
字段类型 |
必填 |
参数名称 |
说明 |
notifyTime |
Date |
是 |
通知时间 |
格式为yyyy-MM-dd HH:mm:ss |
notifyId |
String |
是 |
通知校验ID |
|
charset |
String |
是 |
编码格式 |
编码格式, utf-8 |
version |
String |
是 |
接口版本 |
调用的接口版本1.0 |
signType |
String |
是 |
签名类型 |
签名算法类型,如:SM3WithSm2 |
sign |
String |
是 |
签名 |
签名串 |
appId |
String |
是 |
应用ID |
分配给开发者的应用ID |
spAppId |
String |
否 |
云商通二代分配的服务商应用ID |
|
transCode |
String |
是 |
接口代码 |
与原交易接口代码一致 |
bizData |
String |
是 |
业务参数的集 |
通知参数的集合,最大长度不限,除公共参数外所有通知参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
1.4异步通知机制
1、订单类结果通知规则
(1)当后台通知地址返回success时,则认为通知成功,停止通知。
(2)对于交易时效非常高的场景,建议商户建立主动查询机制【查询订单状态】。
(3)订单后台通知条件:
订单类 |
通知条件 |
说明 |
消费 |
订单成功、订单失败 |
|
担保消费申请 |
订单成功、订单失败 |
|
单会员担保确认 |
订单成功、订单失败 |
|
提现 |
订单成功、订单失败 |
|
转账 |
订单成功、订单失败 |
|
退款 |
订单成功、订单失败 |
|
退票 |
订单成功、订单失败 |
|
划款入账 |
入账成功 |
2、会员类结果通知规则
(1)当后台通知地址返回success时,则认为通知成功,将停止通知。
(2)会员通知条件:
会员类 |
通知条件 |
说明 |
企业会员薄记开户审核结果通知 |
开户成功、开户失败 |
|
会员资料补录结果通知 |
营业执照和法人身份证OCR识别对比结果一致、不一致 |
营业执照和法人身份证分别进行OCR识别比对,每次结果变动,均发送通知 |
会员协议签约结果通知 |
签约成功、签约失败 |
3、通知重发规则
(1)同样的通知可能会多次发送给接收方系统。接收方系统必须能够正确处理重复的通知。
(2)后台通知交互时,如果接收方反馈给通知方的应答不符合规范或超时(链接保持5s),通知方服务器会不断重发通知,直到收到接收方正确的反馈或超过6小时。一般情况下,6小时以内完成7次通知(通知的间隔频率一般是:5s/15s/1m/10m/30m/1h/6h),但通知方不保证通知最终一定能成功。
(3)在订单状态不明或者没有收到支付结果通知的情况下,建议接收方主动调用【交易结果查询】确认订单状态。
1.5验签机制
1. 筛选并排序
获取所有请求参数,不包括字节类型参数,如文件、字节流,剔除sign、signType字段,剔除值为空的参数,并按照第一个字符的键值ASCII码递增排序(字母升序排序),如果遇到相同字符则按照第二个字符的键值ASCII码递增排序,以此类推。
2. 拼接
将排序后的参数与其对应值,组合成“参数=参数值”的格式,并且把这些参数用&字符连接起来,此时生成的字符串为待签名字符串。
3. 将签名参数(sign)使用 base64 解码为字节码串。
4. 调用验签函数:使用各自语言对应的Sm2签名验证函数,传入待验签字段、服务商或者客户公钥、签名内容(经过base64解码)进行验签,根据返回结果判定是否验签通过。
1.6 敏感信息加解密
客户端与服务端之间传递敏感信息,请使用SM4 对称加密算法进行加密后传输。
SM4加密:将传入的密钥(secretKey)的字节数组作为因子通过SHA1PRNG生产一个64位的随机源,构造出原始密钥,通过ECB模式对明文数据进行加密,加密后的字节码转为16进制大写输出。
1.7 签名验签API服务
独立部署一个api服务,加解密调用此服务,方法见附件:
【签名验签API_V2】https://kdocs.cn/l/cnO6tubee5wq
1.8 公共返回码(code及msg)
code(返回码) |
msg(返回码描述) |
00000 |
调用成功(接口调用成功) |
1.9 业务返回码(respCode及respMsg)
分类 | 错误码 | 错误描述 |
接口调用结果类 | 00000 | 交易成功 |
66666、66667 | 处理中,即当前的请求已受理,需要继续调用关联的确认类接口,或通过发起订单查询、等待异步通知,来获取处理状态。 | |
接口字段及功能类 | 10000 | 暂不支持个人会员转账 |
参数错误 | ||
10001 | 聚合支付客户不支持该支付模式 | |
聚合支付客户不支持上送抽佣金额 | ||
聚合支付客户不支持上送营销金额 | ||
10002 | 必填域缺失(name) | |
必填域缺失(reqTraceNum) | ||
必填域缺失(cerType) | ||
必填域缺失(enterpriseBaseInfo) | ||
必填域缺失(bankAcctDetail) | ||
必填域缺失(enterpriseAdress) | ||
必填域缺失(acctNum) | ||
必填域缺失(receiverList) | ||
必填域缺失(orderAmount) | ||
10003 | 消息域格式不合法(legalPersonCerNum) | |
消息域格式不合法(batchNo) | ||
消息域格式不合法(orderValidTime) | ||
消息域格式不合法(acctNum) | ||
11001 | 不支持该功能 | |
10090 | 证书加载失败 | |
应用类 | 20000 | 应用不存在 |
20001 | 应用编码不存在 | |
20002 | 操作频繁,请稍后再试 | |
20003 | 应用没有权限使用此接口 | |
20004 | 应用没有开通该支付方式 | |
20005 | 应用待激活 | |
20006 | 应用已禁用 | |
20007 | 服务商应用绑定关系不存在 | |
20008 | ||
20009 | ||
20010 | 无此微信参数支付产品配置 | |
会员类报错 | 30001 | 付款会员不存在 |
30002 | 付款会员状态异常 | |
30003 | 收款会员不存在 | |
30004 | 收款会员状态异常 | |
30005 | 收款会员类型不能作为收款方 | |
30006 | 只支持企业会员开通“平台同主体”角色 | |
30007 | 该应用下会员已存在 | |
30008 | 未找到行业版角色管控规则 | |
30009 | 不符合行业版角色管控规则 | |
30010 | 企业名称含“公司”,不支持上送“个体工商户” | |
30011 | 实名开户会员未注册时,会员角色必须上送 | |
30012 | 会员已注册时,会员角色如果上送得和现有角色一致 | |
30013 | 若绑卡,则银行卡四要素信息字段必须均上送 | |
30014 | 该证件号已开户的数量已达到风控阀值 | |
30015 | 个人实名接口上送企业会员,该应用配置不支持绑定法人卡 | |
30016 | 个人实名接口上送企业会员时,需要会员为有效状态 | |
30017 | 不支持此证件类型 | |
30018 | 会员已实名 | |
30019 | 非大陆身份证不支持绑卡方式8-银行卡四要素认证 | |
30020 | 会员状态异常 | |
30021 | 企业实名不支持个人 | |
30022 | 仅个体工商户支持上送对私账户 | |
30023 | 绑卡申请订单状态不正确 | |
30024 | 申请和确认上送手机号不一致 | |
30025 | 分账会员不存在 | |
30026 | 分账会员状态异常 | |
30027 | 银行卡已绑定 | |
30028 | 付款会员账户状态异常 | |
30029 | 收款会员账户状态异常 | |
30030 | 分账会员账户状态异常 | |
30031 | 未匹配到卡bin | |
未匹配到卡bin | ||
30032 | 卡号黑名单验证不通过 | |
30033 | 证件黑名单验证不通过 | |
证件黑名单验证不通过 | ||
30034 | 企业性质不正确 | |
30035 | 企业状态是吊销、注销、歇业! | |
30036 | 企业照面比对失败 | |
30037 | 身份证认证失败 | |
30038 | 已挂失卡 | |
30039 | 手机号黑名单验证不通过 | |
认证未全部通过 | ||
法人非身份证,待上传影印件,人工审核! | ||
公司名称不一致 | ||
企业照面比对结果:照面比对一致;法人认证结果:一致 | ||
30040 | 该应用收付通协议签约配置不存在 | |
30041 | 该应用收银宝协议签约配置不存在 | |
30042 | 会员不存在 | |
30043 | 不支持非企业会员 | |
30044 | 该会员状态不满足 审核失败/有效 | |
30045 | 上传身份证影印件时,则肖像面和国徽面必须同时上传 | |
30046 | 收款会员未签署收款协议 | |
30047 | 分账会员未签署分账协议 | |
30048 | 企业会员拓展信息记录不存在 | |
30049 | 企业会员法人姓名不一致 | |
30050 | 会员已实名 | |
30051 | 该应用下的该会员已绑定收银宝商户号 | |
30052 | 卡号不存在 | |
30053 | 企业会员法人证件类型不一致 | |
30054 | 企业会员法人证件号码不一致 | |
30055 | 企业会员仅支持绑定一张法人卡 | |
30056 | 该统一社会信用已开户的数量已达到风控阀值 | |
30057 | 该手机号已开户的数量已达到风控阀值 | |
30058 | 统一社会信用代码黑名单验证不通过 | |
30059 | 法人证件号黑名单验证不通过 | |
30060 | 法人手机号黑名单验证不通过 | |
30061 | 银行预留手机号黑名单验证不通过 | |
30062 | 会员不支持提现 | |
30063 | 手机号黑名单验证不通过 | |
30064 | 已实名绑卡前提 实名信息与原实名信息不一致 | |
30065 | 未找到对应应用或通配应用风控-企业会员账户管控 | |
30066 | 企业会员仅支持对公提现 | |
30067 | 企业实名上送对私账号 银行预留手机字段必填 | |
30068 | 企业实名对公账号 银行代码必填 | |
30069 | 充值业务模式配置错误 | |
30070 | 平台会员扩展信息不存在 | |
30071 | 企业会员实名开户会员角色为平台同主体,上送统一信用代码和平台不一致 | |
30072 | 企业实名对公账号 开户行支行名称必填 | |
30073 | 企业实名对公账号 支付行号必填 | |
30074 | 会员资料补录非法人身份证,不允许上送肖像面和国徽面 | |
30075 | 银行代码不正确 | |
30076 | 该手机号已开户的数量已达到风控阀值 | |
30077 | 会员资料补录法人证件类型为身份证,其他影印件类型不支持上送法人非身份证证件 | |
30078 | 会员资料补录 其他影印件类型字段不支持上送 该枚举值 | |
30079 | 会员未绑定手机号 | |
30080 | 会员未实名 | |
30081 | 会员未设置角色 | |
30082 | 会员角色未匹配管控 | |
30083 | 签约户名非企业名称 | |
30084 | 签约户名非个人名称 | |
30085 | 手机号不一致 | |
30086 | 分账会员非分账方角色 | |
30087 | 法人账户提现协议名称不对 | |
30088 | 收款方和付款人信息不能一致 | |
30089 | 不支持平台方进行付款 | |
30090 | 协议未上传 | |
30091 | 协议已签约成功 | |
30092 | 协议不需要签订 | |
30093 | 会员类型不支持协议 | |
30094 | 签约比例大于行业产管控 | |
30095 | 此收款方和分账方间不需要签约 | |
30096 | 非收款会员不支持上送分账信息 | |
30097 | 支付账户开户仅支持企业会员 | |
30098 | 已存在待激活的支付账户 | |
30099 | 云商通--企业会员 统一客户--个人:规则1 核对不一致 | |
云商通--企业会员 统一客户--企业、个体户、其他组织、事业部:规则2 使用平台商户信息来核对不一致 | ||
平台商户信息核对:企业名称不一致;统一社会信用证不一致;法人姓名不一致;法人证件号码不一致 | ||
法人姓名(云商通)和法人姓名(统一客户)不相同;法人证件号码(云商通)和 法人证件号码(统一客户)不相同 | ||
30100 | 企业会员已实名情况下 支付账户开户上送的会员角色不一致 | |
30101 | 企业会员不存在或未实名情况下 支付账户开户法人证件类型仅支持身份证 | |
30102 | 该企业会员已实名,法人证件类型不为身份证,不支持支付账户开户 | |
30103 | 企业会员支付账户开户,当商户类型=公司/合伙企业,则受益人判定标准必填 | |
30104 | 企业会员支付账户开户,当商户类型=公司/合伙企业,则受益人证明材料必填 | |
30105 | 企业已实名情况下 支付账户开户上送的银行账户需要与本地该会员银行账户信息一致 | |
30106 | 开户附件材料 法人身份证国徽面照片和法人身份证人像面照片需要同时上送 | |
30107 | 字段长度超过限制 | |
30108 | 协议已全部签署成功,无需签署 | |
30109 | 支付账户不存在 | |
30110 | 上送的地区码不存在 | |
30111 | 名称不正确 | |
30112 | 会员已绑定手机号 | |
30115 | 来款银行账户非指定账户 | |
30116 | 非收款方或分账方角色不支持签约 | |
30117 | 行业角色不支持签订分账协议 | |
30118 | 会员不允许收款 | |
30119 | 会员不允许分账 | |
30120 | 未配置鉴权方式 | |
30121 | 提现会员不存在 | |
30122 | 提现会员状态异常 | |
30123 | 提现会员状态异常 | |
30124 | 应用资金管理模式不支持上送字段 | |
30125 | 应用未配置资金管理模式 | |
30126 | 交易处理(综合支付)暂不支持POS支付模式 | |
30127 | 账后结算(ISV分账)支付模式必填 | |
30128 | 账后结算(ISV分账)支付模式必须上送子商户号 | |
30129 | 账后结算(ISV分账)收款人进件商户号与上送子商户号不一致 | |
30130 | 非收单商户不支持此签订此协议! | |
30131 | 仅支持按比例抽佣 | |
30132 | 该会员所属应用资金管理模式非帐后结算 | |
30133 | 签约主体非收款方角色不支持签约 | |
30134 | 【行业版订单管控】菜单未配置平台抽佣比例 | |
30135 | 【行业版角色管控】菜单未配置平台分账比例 | |
30136 | 未配置收银宝渠道商户号 | |
30137 | 未配置收银宝渠道商户号 | |
30138 | 平台抽佣超出签约比例 | |
30139 | 抽佣风控未配置 | |
30140 | 已达到绑定对公户数量上限 | |
30141 | 此银行账号已绑定 | |
30142 | 账后结算(ISV分账)收款人统一客户号与上送子商户号不一致 | |
30143 | 账户信息保护 | |
30200 | 企业实名开户接口 企业地址长度超过90 | |
30201 | 此收款方和分账方间不需要签约 | |
30202 | 签约比例大于行业产品管控比例 | |
30203 | 该应用收付通实时付款/代付配置不存在 | |
30204 | 云商通银行代码未找到对应的统一客户银行代码 | |
30205 | 商户号与当前应用未绑定 | |
30206 | 该会员不存在待激活的支付账户,不支持上送该类型的其他影印件材料 | |
30207 | 该应用未开通 银行托管模式 | |
30208 | 该应用未配置 中信银行商户编号 | |
30209 | 该应用未配置 中信银行平台商户编号 | |
30210 | 该应用未配置 中信银行渠道商户编号 | |
30211 | 当为子商户/用户登记薄时,银行子账号必填 | |
30212 | 中信绑卡申请上送的银行子账号不正确 | |
30213 | 商户号未打标签 | |
30214 | 该应用开通了银行托管模式,但银行编码为空 | |
30215 | 上送的银行编码与应用开通银行托管模式对应的银行编码不一致 | |
30216 | 平台资金查询接口,查询类型为商户待结算资金,商户号字段不能为空 | |
30217 | 退款资金调拨收付通渠道账户为空 | |
30218 | 获取银行商户号失败 | |
30219 | 托管银行为中信银行时,查询开始日期和结束日期必须一致 | |
30220 | 不支持的信息类型 | |
30221 | 提现申请待结算户类型 该银行卡非结算卡 | |
30222 | 提现申请待结算户类型 该银行卡未绑定 | |
30223 | 待结算户未开立 | |
30224 | 该会员编号已存在,请使用新的会员编号进件 | |
30225 | 该会员已进件成功,商户号XXX | |
30326 | 商户进件账户类型为对私时,银行预留手机号必填 | |
30327 | 商户进件账户类型为对公时,银行代码必填 | |
30328 | 该会员未进件成功 | |
30329 | 该会员未进件过 | |
30330 | 会员已存在,非进件会员 | |
30331 | 会员角色与原设置角色不一致 | |
30332 | 应用结算账户为空 | |
30333 | 应用银行客户证书未配置 | |
30334 | 会员待结算账户不在白名单中 | |
30335 | 会员资料补录接口必须上送图片信息 | |
30336 | 未查询到已签约的协议 | |
30337 | 该服务商没有权限使用此接口 | |
30338 | 该应用资金管理模式数据未配置开户银行 | |
30339 | 上传开户银行与该应用开户银行不匹配 | |
30340 | 银行子账户开户待审核 | |
30341 | 身份证正面照、身份证反面照、统一社会信用代码、其他影印件不能同时为空 | |
30342 | 分账出金方资质审核未通过,不允许交易 | |
30343 | 分账入金方资质审核未通过,不允许交易 | |
30344 | 提现会员资质审核未通过,不允许交易 | |
30345 | 分账人列表文件内容解析失败 | |
30346 | 会员簿记账户不存在 | |
30347 | 会员支付账户不存在 | |
交易类 | 40000 | 订单不存在 |
订单不存在 | ||
40001 | 抽佣金额超过允许范围 | |
40002 | 订单状态不正确 | |
40003 | 分账数据上送有误,分账会员数超过允许最大的分账会员数 | |
40004 | 分账数据上送有误,分账金额超过允许最大的分账金额 | |
40005 | 订单金额需等于支付金额+营销金额 | |
40006 | 协议号不一致 | |
40007 | 收款人会员编号不正确 | |
40008 | 未配置应用提现交易允许时间 | |
40009 | 当前时间不支持提现 | |
40010 | 同一笔订单下收款人不能重复 | |
收款人与担保申请收款人不一致 | ||
同一收款人下分账人不能重复 | ||
40011 | 收款人金额超出可确认金额 | |
40012 | 收款人金额列表和订单金额列表不符 | |
40013 | 订单金额超过允许范围 | |
40014 | 平台作为收款人且应用资金管理模式为非账后结算时,平台账户类型仅支持上送应用储值卡账户和平台簿记账户 | |
40015 | 该资金管理模式不支持簿记账户充值 | |
40016 | 分账方与源交易分账方不一致 | |
40017 | 不支持贷记卡充值 | |
40018 | 不支持贷记卡充值 | |
40019 | 不支持贷记卡充值 | |
40020 | 交易账户子账户资金不足 | |
40021 | 验证码错误次数超过限制 | |
40031 | 该订单类型不支持关闭 | |
40033 | 该支付模式不支持关闭 | |
40101 | 超过当日累计笔数支付限制 | |
40102 | 超过日累计金额支付限制 | |
40103 | 超过月累计金额支付限制 | |
40104 | 超过当日累计笔数订单限制 | |
40105 | 超过日累计金额订单限制 | |
40108 | 超过单笔金额订单限制 | |
40110 | 商户号限制交易 | |
40200 | 会员支付账户未绑定该银行卡 | |
40201 | 该银行卡不是支付账户绑定的银行卡 | |
40202 | 平台支付账户不存在 | |
40203 | ||
40204 | ||
40205 | ||
40206 | ||
40207 | ||
40208 | 上送的支付账户与会员自身的支付账户不一致 | |
40209 | 资金管理模式=账后结算时,订单退款详情必填 | |
40210 | 订单退款详情中的渠道退款金额与资金确认退款金额其中一项必填 | |
40211 | 上送渠道退款金额时,退款总金额必须与渠道退款金额一致 | |
40212 | 不上送渠道退款金额时,退款总金额必须与资金确认退款金额一致 | |
40213 | 未找到该应用对应的微信B2b授权appId | |
45500 | 身份证号格式有误 | |
渠道返回失败 | ||
已挂失卡 | ||
无此原交易 | ||
6602900601500JK不允许提交商户55229004215696L的请求 | ||
101 每个二维码仅限使用一次,请刷新再试 | ||
报文格式错误customerIp[9199011] | ||
终端管理接口响应失败 | ||
其他 | 55500 | 模拟环境未查得 |
71006 | 短信验证码错误 | |
99999 | 余额不足 | |
未知异常 | ||
识别失败 | ||
空 | 收款人抽佣金额列表和抽佣金额列表不符 |