线上分账登记
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2024.01.23 | 初版 |
2、业务说明
(1)接口说明
1、对于需要把一个账户的钱分给其它对应的相关的商户,调用此接口
2、多于用一个订单里有多个收款方,或合作商户的场景
3、如景点,园区收款方和里面的具体项目为不同的收款方,卖出一张票时,可以分给两方
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/unify/division/online/divRegist |
正式环境 | https://ysgate.ysepay.com/openapi/unify/division/online/divRegist |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:unify.division.online.divRegist |
charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
version | String | Y | 调用的接口版本,固定为:1.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
notifyUrl | String(190) | Y | 异步通知地址,异步通知地址,商户通过该地址接收异步通知 |
orderId | String(32) | Y | 订单号 |
payeeMercId | String(20) | Y | 主商户号,原交易收款方商户号 |
amount | String(10) | Y | 原订单交易金额,必需为正整数。单位:分 |
sysFlag | String(2) | N | 系统标志,DD:订单交易,DS:代收交易,默认是DD,订单交易 |
isDivistion | String(2) | Y | 原订单是否参与分账,01:是,02否 |
isDivisionAgain | String(1) | Y | 是否重新分账,Y:是,N:否 |
divisionMode | String(2) | Y | 分账模式,01 :比例,02:金额 |
divList | Array | N | 分账明细,参与分账时不可以空,明细中的是否必填按照分账来描述。 |
4.2.1 divList具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
divMercId | String(20) | Y | 分账商户号,参与分账商户号 |
isChargeFee | String(2) | Y | 是否收取手续费,01:是,02否。若配置手续费收支分离,该参数配置的手续费承担方不生效 |
divAmount | String(10) | N | 分账金额,必需为正整数。单位:分单位:分 |
divRatio | dubble | N | 分账比例,divMode=01时必填,小数格式,最小长度1位,最大4位小数位(例:0.2365), 分账明细中所有分账比例之和必须为1。 |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
msg | String(50) | Y | 网关响应码描述 |
subCode | String | Y | 业务响应码,参见具体的API接口文档 |
subMsg | String | Y | 业务响应描述 |
timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
norce | String(128) | Y | 随机参数 |
sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
businessData | Object | N | 响应数据 |
reqMsgId | String | Y | 请求流水号 |
5.2.1 businessData具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
returnInfo | String | Y | 返回说明 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 成功 | |
9999 | 失败 | |
5000 | 交易超时 | |
A029998 | 网关非法参数 | 检查请求参数,修改后重新发起请求 |
B020100 | 参数校验错误 | 检查请求参数,修改后重新发起请求 |
B021100 | 前置系统参数验证错误 | 检查请求参数,修改后重新发起请求 |
B023003 | 商户号错误 | 检查商户号数据 |