商户开通余额分账功能
商户通过该接口开通分账功能,需要提供进行出账的承诺授权函。
接口说明
适用对象:
特约商户
请求URL: https://merapi.zfiot.net/api/division/bal/open
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
承诺授权函 | authLetterImg | 是 | String(256) | ["xxxxx", "xxxxxx"] | 商户提供的承诺授权函,附件资源ID最多5张,示例值:["xxxxx", "xxxxxx"] |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
开通状态 | state | 是 | String(1) | 0 | 开通状态 0.审核中 1.成功 9.失败 |
失败原因 | errMsg | 是 | String(128) | 原因说明 | 开通失败时的原因说明 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"appId": "66ad9861d5def240e7f35e2e",
"errMsg": "商户已经开通分账!",
"state": 9,
"mchNo": "M1722652769"
},
"msg": "SUCCESS",
"sign": "0AA81315E77FADC1EAE29199BDA65E2F"
}
创建分账接收方
商户创建分账接收方,通过接收方签约结果查询接口,获取的实际签约状态。
接口说明
适用对象:
特约商户
请求URL: https://merapi.zfiot.net/api/division/bal/receive/create
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方类型 | receiveType | 是 | String(1) | 1 | 接收方类型 1.资料开户-对公 2.资料开户-对私 3.商户号开户(除了接收方商户号,以下资料都无需填写) |
接收方商户号 | tradeMchNo | 否 | String(32) | M1722652769 | 需要开通为接收方的商户号,商户号开户时必填 |
商户号应用ID | tradeMchAppId | 否 | String(32) | 66ad9861d5def240e7f35e2e | 需要开通为接收方的商户号的应用ID,商户号开户时必填 |
接收方名称 | receiveName | 是 | String(64) | 个人-王三 | 接收方名称,个人填个人姓名,例如:王三,企业类型填企业名称或者个体-xxx即可。 |
营业执照号 | licenseNo | 否 | String(32) | 92320581MA7MPR1O6L | 营业执照号,对公必填 |
营业执照企业名称 | licenseName | 否 | String(64) | 企业名称 | 营业执照上的企业名称,对公必填 |
营业执照注册地址 | licenseAddress | 否 | String(128) | 上海市黄浦区新码头街55号4幢3444楼 | 营业执照上的注册地址,对公必填 |
营业执照起始有效日期 | licenseEffectBegin | 否 | String(16) | 2024-01-01 | 营业执照起始有效日期,格式为:yyyy-MM-dd,示例值:2024-01-01,对公必填 |
营业执照截止有效日期 | licenseEffectEnd | 否 | String(16) | 2054-01-01 | 营业执照截止有效日期,对公必填,长期则填长期 |
营业执照图片资源ID | licenseImg | 否 | String(64) | 57915982-5c96-4848-882f-ac8e414a11b6_API | 营业执照图片资源ID |
法人身份证姓名 | legalName | 是 | String(64) | 测试 | 法人身份证姓名,个人类型传个人身份证上姓名 |
法人身份证号 | legalNo | 是 | String(32) | 310102191234534449 | 法人身份证号,个人类型传个人身份证上证件号 |
法人身份证正面 | legalFrontImg | 是 | String(64) | 57915982-5c96-4848-882f-ac8e414a11b6_API | 法人身份证正面资源ID,个人类型传个人身份证正面 |
法人身份证反面 | legalBackImg | 是 | String(64) | 57915982-5c96-4848-882f-ac8e414a11b6_API | 法人身份证反面资源ID,个人类型传个人身份证反面 |
法人身份证有效开始日期 | legalBeginDate | 是 | String(16) | 2024-01-01 | 法人身份证有效开始日期,格式为:yyyy-MM-dd,示例值:2024-01-01,个人类型传个人身份证有效开始日期 |
法人身份证有效结束日期 | legalEndDate | 是 | String(16) | 2034-01-01 | 法人身份证有效结束日期,长期则填长期 |
手机号 | mobile | 是 | String(32) | 13000000000 | 手机号 |
结算银行卡号 | bankCardNo | 是 | String(32) | 62245885235821 | 结算银行卡号 |
结算账户名 | bankCardName | 是 | String(32) | 账户名 | 结算账户名 |
开户支行联行号 | bankBranchCode | 否 | String(32) | 102100005374 | 开户支行联行号(对公结算卡必填) |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
签约状态 | signStatus | 是 | String(1) | 0 | 签约状态: 0.签约中 1.签约成功 3.待签约(初始状态,需法人进行电子签约) 9.签约失败 |
签约失败原因 | signFailReason | 是 | String(128) | 原因说明 | 签约失败原因 |
电子签约链接 | signLink | 是 | String(128) | https://8g.cn/h2dqj | 电子签约链接,待签约状态时返回,需法人打开链接完成签约认证后,账户才生效 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"receiveNo": "M1723599876",
"appId": "66ad9861d5def240e7f35e2e",
"signStatus": 0,
"mchNo": "M1722652769"
},
"msg": "SUCCESS",
"sign": "FCBEBC78F4CEF7EF2E838EFDF68AE7E9"
}
接收方签约结果查询
通过查询接口获取接收方的签约状态,只有签约成功的才会生效。
接口说明
适用对象:
特约商户
请求URL: https://merapi.zfiot.net/api/division/bal/receive/query
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
接收方名称 | receiveName | 是 | String(64) | 个人-王三 | 接收方名称,个人填个人姓名,例如:王三,企业类型填企业名称或者个体-xxx即可。 |
签约状态 | signStatus | 是 | String(1) | 0 | 签约状态: 0.签约中 1.签约成功 3.待签约(初始状态,需法人进行电子签约) 9.签约失败 |
签约失败原因 | signFailReason | 是 | String(128) | 原因说明 | 签约失败原因 |
电子签约链接 | signLink | 是 | String(128) | https://8g.cn/h2dqj | 电子签约链接,待签约状态时返回,需法人打开链接完成签约认证后,账户才生效 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"receiveName": "西安文罗科技有限公司",
"receiveNo": "M1723599876",
"appId": "66a9f292d5deb4d4e000a269",
"signStatus": 0,
"mchNo": "M1722413713"
},
"msg": "SUCCESS",
"sign": "9AAA3E2AD52FACC603FB39CCA2B08E70"
}
商户绑定分账接收方
接收方创建成功后,需要与商户进行绑定,绑定成功后才能进行分账。
接口说明
适用对象:
特约商户
请求URL:https://merapi.zfiot.net/api/division/bal/receive/bind
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 绑定的接收方账号 |
合作协议图片资源ID | coporationImg | 是 | String(64) | 57915982-5c96-4848-882f-ac8e414a11b6_API | 合作协议图片资源ID |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
绑定状态 | bindState | 是 | String(1) | 0 | 绑定状态: 0.绑定中 1.绑定成功 9.绑定失败 |
绑定失败原因 | failDesc | 是 | String(128) | 原因说明 | 绑定失败原因 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"bindState": 0,
"receiveNo": "R1725260310",
"appId": "66ad917dd5de8ae201577b5f",
"mchNo": "M1722651004"
},
"msg": "SUCCESS",
"sign": "2907C4FCC9A9025B044568C5C7E1039E"
}
接收方绑定关系结果查询
获取商户与接收方的绑定结果,只有绑定成功才能进行分账。
接口说明
适用对象:
特约商户
请求URL:https://merapi.zfiot.net/api/division/bal/receive/bind/query
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 绑定的接收方账号 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
绑定状态 | bindState | 是 | String(1) | 0 | 绑定状态: 0.绑定中 1.绑定成功 9.绑定失败 |
绑定失败原因 | failDesc | 是 | String(128) | 原因说明 | 绑定失败原因 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"bindState": 0,
"receiveNo": "R1725352795",
"appId": "66a9f292d5deb4d4e000a269",
"failDesc": "状态关闭",
"mchNo": "M1722413713"
},
"msg": "SUCCESS",
"sign": "5709DF5478885AC0544F44B09BAF2756"
}
余额分账请求
通过该接口对商户的待清算资金发起分账,需要调用查询接口获取实际分账状态,发起分账请求和查询需间隔5秒以上。
接口说明
适用对象:
特约商户
请求URL: https://merapi.zfiot.net/api/division/bal/split
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
商家分账订单号 | mchOrderId | 是 | String(32) | 1725518773 | 商家分账订单号 |
分账总金额 | totalAmount | 是 | Number | 1500 | 分账总金额,以分为单位 |
分账详情 | ledgerDetail | 是 | String(500) | [{"amount":1,"receiveNo":"R1725352795"}] | 分账详情,json数组,详见ledgerDetail详情 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
ledgerDetail详情
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 分账接收方账号 |
分账金额 | amount | 是 | Number | 1500 | 分账金额,以分为单位 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
分账状态 | state | 是 | String(1) | 0 | 该笔订单整体分账状态: 0.分账中 1.分账完成(不代表成功,每笔详情成功或者失败通过查询接口获取) 9.分账失败 |
分账失败原因 | failDesc | 是 | String(128) | 原因说明 | 该笔分账整体失败原因 |
商家分账订单号 | mchOrderId | 是 | String(32) | 1725518773 | 商家分账订单号 |
分账订单号 | orderId | 是 | String(32) | RO1725518774 | 友联plus平台分账订单号 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"orderId": "RO1725866585",
"appId": "66a9f292d5deb4d4e000a269",
"state": 0,
"mchOrderId": "1725866584",
"mchNo": "M1722413713"
},
"msg": "SUCCESS",
"sign": "E90306D50276E148ABA6423DCADF2D72"
}
余额分账结果查询
查询分账订单实际分账结果,默认只查询近3个月内的分账订单。
接口说明
适用对象:
特约商户
请求URL: https://merapi.zfiot.net/api/division/bal/split/query
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
商家分账订单号 | mchOrderId | 否 | String(32) | 1725518773 | 商家分账订单号 |
分账订单号 | orderId | 否 | String(32) | RO1725518774 | 友联plus平台分账订单号,与商家分账订单号二选一必填 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
商家分账订单号 | mchOrderId | 是 | String(32) | 1725518773 | 商家分账订单号 |
分账订单号 | orderId | 是 | String(32) | RO1725518774 | 友联plus平台分账订单号 |
分账详情 | ledgerDetail | 是 | String(500) | [] | 分账详情,json数组,详见ledgerDetail详情 |
ledgerDetail详情
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 分账接收方账号 |
分账金额 | amount | 是 | Number | 1500 | 分账金额,以分为单位 |
分账结果 | result | 是 | String(1) | 0 | 分账结果: 0.分账中 1.分账成功 9.分账失败 |
分账失败原因 | detailFailReason | 是 | String(128) | 原因说明 | 分账失败原因 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"orderId": "RO1725866585",
"appId": "66a9f292d5deb4d4e000a269",
"ledgerDetail": "[{\"result\":0,\"amount\":1,\"receiveNo\":\"R1725352795\"}]",
"mchOrderId": "1725866584",
"mchNo": "M1722413713"
},
"msg": "SUCCESS",
"sign": "BBF95A0AB129A71D2BE372873023FC0D"
}
余额分账回退请求
支持商户调用该接口从分账接收方的账户回退已分账的金额,申请回退总金额不能大于原余额分账分给接收方的金额,退款和分账回退没有耦合,分账回退可以先于退款请求,也可以后于退款请求。
接口说明
适用对象:
特约商户
请求URL:https://merapi.zfiot.net/api/division/bal/split/return
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
商家分账订单号 | mchOrderId | 否 | String(32) | 1725518773 | 商家分账订单号 |
分账订单号 | orderId | 否 | String(32) | RO1725518774 | 友联plus平台分账订单号,与商家分账订单号二选一 |
商家分账回退订单号 | mchReturnOrderId | 是 | String(32) | 1725518773 | 商家分账回退订单号 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
回退金额 | returnAmount | 是 | Number | 1500 | 回退金额,以分为单位,不能超过分账的金额 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
分账回退订单号 | returnOrderId | 是 | String(32) | RT1725520106 | 友联plus平台分账回退订单号 |
商家分账回退订单号 | mchReturnOrderId | 是 | String(32) | 1725520106 | 商家分账回退订单号 |
商家分账订单号 | mchOrderId | 是 | String(32) | 1725520106 | 商家分账订单号 |
分账订单号 | orderId | 是 | String(32) | RO1725433490 | 友联plus平台分账订单号 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
回退金额 | returnAmount | 是 | Number | 1500 | 回退金额,以分为单位 |
回退状态 | result | 是 | String(1) | 0 | 该笔订单回退状态: 0.回退中 1.回退成功 9.回退失败 |
回退失败原因 | failDesc | 是 | String(128) | 原因说明 | 回退失败原因 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"result": 0,
"orderId": "RO1725866585",
"receiveNo": "R1725352795",
"appId": "66a9f292d5deb4d4e000a269",
"mchReturnOrderId": "1725866852",
"returnOrderId": "RT1725866853",
"mchNo": "M1722413713",
"returnAmount": 1
},
"msg": "SUCCESS",
"sign": "2FE301C3BAAC0587D8C54B675E8C907A"
}
余额分账回退结果查询
查询商户分账回退订单的实际回退结果。
接口说明
适用对象:
特约商户
请求URL:https://merapi.zfiot.net/api/division/bal/split/return/query
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
商家分账回退订单号 | mchReturnOrderId | 否 | String(32) | 1725518773 | 商家分账回退订单号 |
分账回退订单号 | returnOrderId | 否 | String(32) | RT1725520106 | 友联plus平台分账订单号,与商家分账回退订单号二选一 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
回退金额 | returnAmount | 是 | Number | 1500 | 回退金额,以分为单位 |
回退结果 | result | 是 | String(1) | 0 | 回退结果: 0.回退中 1.回退成功 9.回退失败 |
回退失败原因 | failDesc | 是 | String(128) | 原因说明 | 回退失败原因 |
分账回退订单号 | returnOrderId | 是 | String(32) | RT1725520106 | 友联plus平台分账回退订单号 |
商家分账回退订单号 | mchReturnOrderId | 是 | String(32) | 1725518773 | 商家分账回退订单号 |
商家分账订单号 | mchOrderId | 否 | String(32) | 1725518773 | 商家分账订单号 |
分账订单号 | orderId | 否 | String(32) | RO1725518774 | 友联plus平台分账订单号 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"result": 0,
"orderId": "RO1725866585",
"receiveNo": "R1725352795",
"appId": "66a9f292d5deb4d4e000a269",
"mchReturnOrderId": "1725866852",
"returnOrderId": "RT1725866853",
"mchOrderId": "1725866584",
"mchNo": "M1722413713",
"returnAmount": 1
},
"msg": "SUCCESS",
"sign": "9051276FA6E71966A73601959F5841AD"
}
账户余额查询
查询商户或接收方账户余额。
接口说明
适用对象:
特约商户
请求URL:https://merapi.zfiot.net/api/division/bal/account/query
请求方式:
POST
请求类型:
application/json
或
application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
账户类型 | accountType | 是 | String(2) | 01 | 账户类型: 01.商户号 02.接收方账号 |
接收方账号 | receiveNo | 否 | String(32) | M1723599876 | 当账户类型为接收方账号时,接收方账号必填 |
请求时间 | reqTime | 是 | Number(20) | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5 |
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | String(10) | 0 | 0-处理成功,其他-处理有误,详见返回码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因 |
签名信息 | sign | 否 | String(32) | 9B4AAE1DADC5A4281B1D165C941A1BE6 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 响应实体,使用json格式数据返回具体业务参数 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(32) | M1722652769 | 友联Plus系统商户号 |
应用ID | appId | 是 | String(24) | 66ad9861d5def240e7f35e2e | 应用ID |
业务代码 | ifCode | 是 | String(10) | 01 | 业务代码,固定值01 |
接收方账号 | receiveNo | 是 | String(32) | M1723599876 | 接收方账号 |
账户类型 | accountType | 是 | String(2) | 01 | 账户类型: 01.商户号 02.接收方账号 |
当前余额 | balance | 是 | Number | 1500 | 当前余额,以分为单位 |
可分账总金额 | avaBalance | 是 | Number | 1500 | 当账号类型为01时,当前商户可分账总金额,以分为单位 当账号类型为02时,当前分账接收方账户待清算金额,以分为单位 |
返回示例数据
{
"code": 0,
"data": {
"ifCode": "01",
"avaBalance": 12,
"balance": 12,
"receiveNo": "R1725352795",
"accountType": "02",
"appId": "66a9f292d5deb4d4e000a269",
"mchNo": "M1722413713"
},
"msg": "SUCCESS",
"sign": "72067252C98C9568F0E1A6405FF99BFD"
}