分账业务
业务介绍:商户分账主要用于商户将交易成功的资金,按照一定的周期,分账给其他方,可以是合作伙伴、员工、用户或者其他分润方。
参考微信文档:
微信分账:https://pay.weixin.qq.com/wiki/doc/api/allocation.php?chapter=26_1
支付宝分账: https://opendocs.alipay.com/open/20190308105425129272/intro
接口目录:
绑定分账用户
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/receiver/bind
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
接口代码 | ifCode | 是 | String(20) | wxpay | wxpay-微信官方接口 ; alipay-支付宝官方接口 |
接收者账号别名 | receiverAlias | 是 | String(64) | 张三 | 接收者账号别名 |
是 | long | 10001 | 需先登录商户系统查找待加入的组ID (20241010已废弃, 无需传入) | ||
分账接收账号类型 | accType | 是 | int | 1 | 分账接收账号类型: 0-个人(对私) 1-商户(对公) |
分账接收账号 | accNo | 是 | String(512) | 1231312@qq.com | 分账接收账号, 微信个人是openid, 支付宝可以是userId或登录名 |
分账接收账号名称 | accName | 否 | String(30) | 张三 | 微信选填(当填入则验证),支付宝账号必填 |
分账关系类型 | relationType | 是 | String(30) | wxpay | 分账关系类型: SERVICE_PROVIDER:服务商 STORE:门店 STAFF:员工 STORE_OWNER:店主 PARTNER:合作伙伴 HEADQUARTER:总部 BRAND:品牌方 DISTRIBUTOR:分销商 USER:用户 SUPPLIER:供应商 CUSTOM:自定义 |
分账关系类型名称 | relationTypeName | 否 | String(30) | wxpay | 当relationType=CUSTOM 必填 |
渠道特殊信息 | channelExtInfo | 否 | String(256) | {} | 渠道特殊信息 |
默认分账比例 | divisionProfit | 是 | String(10) | 0.3 | 若分账30% 则填入 0.3 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': 'MD5MD5MD5MD5MD5MD5MD5MD5MD5MD5MD5MD5',
'mchNo': 'M1623997000',
'appId': '60cc3ba74ee0e6685f57e000',
'ifCode': 'wxpay',
'receiverAlias': '我的第一个账号',
'receiverGroupId': '100001',
'accType': '0',
'accNo': 'sfsfsd@qq.com',
'accName': '张三',
'relationType': 'OTHERS',
'relationTypeName': '我的员工',
'divisionProfit': '0.3'
}
返回参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
绑定账号ID | receiverId | 是 | long | 10001 | 绑定账号ID, 订单分账将使用该ID |
接收者账号别名 | receiverAlias | 是 | String(64) | 张三 | 接收者账号别名 |
分账接收账号类型 | accType | 是 | int | 1 | 分账接收账号类型: 0-个人(对私) 1-商户(对公) |
分账接收账号 | accNo | 是 | String(10) | 1231312@qq.com | 分账接收账号 |
分账接收账号名称 | accName | 否 | String(30) | 张三 | 分账接收账号名称 |
分账关系类型 | relationType | 是 | String(30) | wxpay | 分账关系类型 |
渠道特殊信息 | channelExtInfo | 否 | String(256) | wxpay | 渠道特殊信息 |
默认分账比例 | divisionProfit | 是 | String(10) | wxpay | 默认分账比例 |
绑定成功时间 | bindSuccessTime | 是 | Long | 1622016572190 | 绑定成功时间 |
绑定状态 | bindState | 是 | int | 1 | 绑定状态 1-绑定成功, 0-绑定异常 |
渠道错误码 | errCode | 否 | String | ACQ.PAYMENT_AUTH_CODE_INVALID | 上游渠道返回的错误码 |
渠道错误描述 | errMsg | 否 | String | Business Failed 失败 | 上游渠道返回的错误描述 |
返回示例数据
{
"code": 0,
"data": {
"accName": "张三",
"accNo": "sfsfsd@qq.com",
"accType": 0,
"appId": "60cc3ba74ee0e6685f57eb1e",
"bindState": 0,
"divisionProfit": 0.3,
"errCode": "NOAUTH",
"errMsg": "无分账权限",
"ifCode": "wxpay",
"mchNo": "M1623997351",
"receiverAlias": "我的第一个账号",
"receiverGroupId": 100001,
"relationType": "OTHERS",
"relationTypeName": "我的员工"
},
"msg": "SUCCESS",
"sign": "552CB91FA1E1DB378A534B377E4E9403"
}
易宝支付分账绑定示例:
A场景: 已经在易宝系统完成了进件操作, 那么直接传入【易宝子商户号】完成绑定接收方就可以了。
{
"ifCode": "yeepay",
"relationType": "PARTNER",
"accNo": "10090488888", // 易宝子商户号
"accName": "张三",
"sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"reqTime": "1721955211",
"version": "1.0",
"relationTypeName": "合作伙伴",
"channelExtInfo": "{}",
"appId": "668fa492e4b085a7accaa2b2",
"signType": "MD5",
"receiverAlias": "张三",
"accType": 0,
"divisionProfit": "0.05",
"mchNo": "M1720689810"
}
B场景: 全新资料录入,并将分账接收方账号绑定到商户下。
{
"ifCode": "yeepay",
"relationType": "PARTNER",
"accNo": "6228487890123456", // 该场景下,传银行卡号即可,当易宝开户成功后系统会自动替换为易宝商户号
"accName": "张三",
"sign": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"reqTime": "1721956359",
"version": "1.0",
"relationTypeName": "合作伙伴",
"channelExtInfo": "{\"isMchDivisionReceiver\":1,\"merchantType\":1,\"bankAccountType\":\"\",\"mchShortName\":\"张三_商户\",\"idcard1Img\":\"https://devplusmgr.jeepay.vip/api/anon/localOssFiles/applyment/f9b83f2e-ff38-419f-8e4e-d5ba628c99e3.jpg\",\"idcard2Img\":\"https://devplusmgr.jeepay.vip/api/anon/localOssFiles/applyment/4fd25633-1a52-4de0-bf98-e7f9a0346415.jpg\",\"idcardName\":\"张三\",\"idcardNo\":\"130100199012111111\",\"legalPhone\":\"13800138000\",\"areaCode\":[\"110000\",\"110100\",\"110101\"],\"address\":\"北京市西城区xxx号\",\"bankCode\":\"ICBC\",\"settAccountNo\":\"6228487890123456\",\"mchFullName\":\"张三_商户\"}",
"appId": "668fa492e4b085a7accaa2b2",
"signType": "MD5",
"receiverAlias": "张三",
"accType": 0,
"divisionProfit": "0.1",
"mchNo": "M1720689810"
}
channelExtInfo: 说明:
【小微开户】
{
"isMchDivisionReceiver": 1, // 是否分账接收方 固定传1
"merchantType": 1, // 商户类型 1-个人(小微), 2-个体工商户, 3-企业
"bankAccountType": "", // 账户类型 ENTERPRISE_ACCOUNT(对公账户)--个体和企业可选 DEBIT_CARD(借记卡)--个体和小微可选(小微已经默认上送了借记卡,接口可不用再上送)
"mchShortName": "张三_商户", // 商户简称
"idcard1Img": "https://devplusmgr.jeepay.vip/api/anon/localOssFiles/applyment/f9b83f2e-ff38-419f-8e4e-d5ba628c99e3.jpg", // 法人证件人像面照片 需外网可访问地址
"idcard2Img": "https://devplusmgr.jeepay.vip/api/anon/localOssFiles/applyment/4fd25633-1a52-4de0-bf98-e7f9a0346415.jpg", // 法人证件非人像面照片 需外网可访问地址
"idcardName": "张三", // 法人姓名
"idcardNo": "130100199012111111", // 法人身份证号
"legalPhone": "13800138000", // 法人手机号
"areaCode": ["110000", "110100", "110101"], // 经营地址,三个值顺序固定 省编码,市编码,区编码(直筒子市传对应的乡镇编码,在文档上也在区编码那一列查找就好)
"address": "北京市西城区xxx号", // 经营地址 不需要再次上送省市区
"bankCode": "ICBC", // 开户总行编码(https://yeepay.feishu.cn/sheets/MmMfsrTbnhn744tjYdEcvoNmn83)
"settAccountNo": "6228487890123456", // 银行账户号码
"mchFullName": "张三", // 商户签约名称 与商户证件主体名称一致(个体、企业填写营业执照名称,小微不用再上送(默认固定为了法人名称))
"mchSettleCycle": "D1_MANUAL", // 结算方式,非必填,默认D1 D1:自动结算, D1_MANUAL:手动结算
}
【企业开户】
{
"isMchDivisionReceiver": 1, // 是否分账接收方 固定传1
"mchSettleCycle": "D1_MANUAL", // 结算方式,非必填,默认D1 D1:自动结算, D1_MANUAL:手动结算
"contactName": "联系人姓名",
"contactIdcardNo": "联系人身份证号",
"contactPhone": "13800138001", // 联系人手机号
"servicePhone": "13800138003", // 客服电话
"merchantType": 3, // 3-企业
"bankAccountType": "ENTERPRISE_ACCOUNT", // 账户类型 ENTERPRISE_ACCOUNT(对公账户)
"licenseImg": "http://127.0.0.1:9217/20240929/3b48414f-b5a7-4d59-b374-ecfc0a96f9cc.jpg", // 营业执照照片 需外网可访问地址
"mchFullName": "营业执照名称",
"mchShortName": "商户简称",
"licenseNo": "营业执照号",
"idcard1Img": "http://127.0.0.1:9217/20240929/cb0e2f9c-a9bf-4ec0-8013-4e1708ce0ae7.jpg", // 法人证件人像面照片 需外网可访问地址
"idcard2Img": "http://127.0.0.1:9217/20240929/7c85ce17-ade2-47d0-a803-40755d01a385.jpg", // 法人证件非人像面照片 需外网可访问地址
"idcardName": "法人姓名",
"idcardNo": "法人身份证号",
"legalPhone": "13800138000", // 法人手机号
"mccCode": "", // 非必填。 特殊场景填入, 参考文档 示例: 120_120006 ( 一级_二级)
"areaCode": ["110000", "110100", "110101"], // 经营地址,三个值顺序固定 省编码,市编码,区编码(直筒子市传对应的乡镇编码,在文档上也在区编码那一列查找就好)
"address": "北京市西城区xxx号", // 经营地址 不需要再次上送省市区
"contactEmail": "法人邮箱@qq.com", // 法人邮箱
"bankCode": "CCB", // 开户总行编码(https://yeepay.feishu.cn/sheets/MmMfsrTbnhn744tjYdEcvoNmn83)
"settAccountNo": "62结算账号8888888", // 银行账户号码
"companyAccountLicenseImg": "http://127.0.0.1:9217/ap9/416c4ad6-8046-4c93-bcc2-c98b15a9ffdc.jpg" // 开户许可证照片 需外网可访问地址
}
易宝银行编码查询: https://yeepay.feishu.cn/sheets/MmMfsrTbnhn744tjYdEcvoNmn83
易宝省市编码查询:https://yeepay.feishu.cn/file/HMtPbm3XPofOWbxMu1mcrZtInch
易宝支付MCC行业经营类目: 文章末尾附件下载
发起订单分账
当订单下单时传入的分账模式 divisionMode = 2商户手动分账(解冻商户金额),支持商户手动发起订单分账。
注意:需要在订单支付完成后(建议1分钟后)调用分账接口。
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/exec
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
支付订单号 | payOrderId | 否 | String(30) | P20160427210604000490 | 支付中心生成的支付订单号,与mchOrderNo二者传一即可 |
商户单号 | mchOrderNo | 否 | String(64) | 20160427210604000490 | 商户生成的支付单号,与payOrderId二者传一即可 |
是否解冻剩余未分账资金: 0-否 1-是 | autoFinish | 否 | int | 1 | 是否解冻剩余未分账资金: 0-否 1-是,默认0 |
分账模板 | templateId | 否 | long | 1 | 分账模板,与receivers至少传一项 |
分账接收者账号列表 | receivers | 否 | String(512) | [] | 接收者账号列表(JSONArray 转换为字符串类型) 仅当useSysAutoDivisionReceivers=0 时该字段值有效。 参考: 方式1: 按账号维度 [{ receiverId: 800001, divisionProfit: 0.1, //(实际分账比例 如分账10%传入0.1, 若不填入则使用系统默认配置值) divisionAmount: 100, //(实际分账金额,单位:分,与分账比例二选一, 若比例和金额两个都填写,以分账金额为准。) }] [{ receiverGroupId: 100001, //(该组所有 当前订单的渠道账号并且可用状态的全部参与分账) divisionProfit: 0.1 (每个账号的分账比例, 若不填入则使用系统默认配置值, 建议不填写) }] 注意: 分账的比例和金额不支持共传,若同时存在将会导致分账计算金额错误,接口调用时请先确定一种计算方式 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'mchNo': 'M1623997351',
'appId': '60cc3ba74ee0e6685f57eb1e',
'payOrderId': 'P202108271011463510002',
'useSysAutoDivisionReceivers': '0',
'receivers': '[{"receiverGroupId":"","receiverId":"800029","divisionProfit":"0.0001"},{"receiverGroupId":"","receiverId":"800028","divisionProfit":"0.0002"}]'
}
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账状态 | state | 是 | int | 2 | 分账状态 1-分账成功, 2-分账失败, 3-分账处理中,4-分账已受理 |
上游分账批次号 | channelBatchOrderId | 否 | String(30) | T20160427210604000490 | 上游分账批次号 |
系统分账批次号 | batchOrderId | 否 | String(30) | D1792435159956271105 | 系统分账批次号 v3.7.0新增 |
渠道错误码 | errCode | 否 | String | 1002 | 渠道返回错误码 |
渠道错误描述 | errMsg | 否 | String | ERROR | 渠道返回错误描述 |
返回示例数据
{
"code": 0,
"data": {
"errCode": "unknown-sub-code",
"errMsg": "Business Failed【未知的错误码ACQ.ROYALTY_ACCOUNT_NOT_EXIST】",
"state": 2
},
"msg": "SUCCESS",
"sign": "56836E18015DD7E4FAFE45380C0AD098"
}
订单分账查询
订单分账结果的查询。
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/query
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
支付订单号 | payOrderId | 否 | String(30) | P20160427210604000490 | 支付中心生成的支付订单号,与mchOrderNo二者传一即可 |
商户单号 | mchOrderNo | 否 | String(64) | 20160427210604000490 | 商户生成的支付单号,与payOrderId二者传一即可 |
系统分账批次号 | batchOrderId | 是 | String(30) | D1622016572190 | 分账接口返回的系统分账批次号 |
分账接收者ID | receiverId | 否 | long | 80000021 | 非必填,若传入则仅查询该ID的分账结果 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'mchNo': 'M1623997351',
'appId': '60cc3ba74ee0e6685f57eb1e',
'payOrderId': 'P202108271011463510002',
'batchOrderId': 'D99832829483234'
}
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
支付系统订单号 | payOrderId | 是 | Stirng | P92332433423442 | 支付系统订单号 |
系统分账批次号 | batchOrderId | 是 | String(30) | D20160427210604000490 | 系统分账批次号 |
上游分账批次号 | channelBatchOrderId | 否 | String(30) | TGES202106040 | 上游分账批次号,可能为空 |
详细信息 | records | 否 | String | JSON数组,String类型 | 详细信息 |
records数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账记录ID | recordId | 是 | Stirng | 1007 | 分账记录ID |
状态 | state | 否 | int | 1 | 状态: 0-待分账 1-分账成功, 2-分账失败, 3-分账处理中,4-分账已受理 |
分账接收者ID | receiverId | 否 | Long | 800001 | 分账接收者ID |
组ID | receiverGroupId | 否 | Long | 9801 | 组ID |
分账接收者别名 | receiverAlias | 否 | String | 张三 | 分账接收者别名 |
分账接收账号 | accNo | 否 | String | 628480039999330009 | 分账接收账号 |
分账接收账号名称 | accName | 否 | String | 张三 | 分账接收账号名称 |
分账接收账号类型 | accType | 否 | int | 1 | 0-个人 1-商户 |
系统分账批次号 | batchOrderId | 否 | String | D1000001 | 系统分账批次号 |
上游分账批次号 | channelBatchOrderId | 否 | String(30) | TGES202106040 | 上游分账批次号,可能为空 |
计算该接收方的分账金额 | calDivisionAmount | 否 | String | 1908 | 计算该接收方的分账金额,单位分 |
实际分账比例 | divisionProfit | 否 | Decimal | 0.200000 | 实际分账比例 |
返回示例数据
{
"code":0,
"data":{
"batchOrderId":"D1792435159956271105",
"records":"[{\"accName\":\"A\",\"accNo\":\"A\",\"accType\":0,\"batchOrderId\":\"D1792435159956271105\",\"calDivisionAmount\":1980,\"divisionProfit\":0.200000,\"receiverAlias\":\"A\",\"receiverGroupId\":100001,\"receiverId\":800001,\"recordId\":1007,\"state\":1},{\"accName\":\"B\",\"accNo\":\"B\",\"accType\":0,\"batchOrderId\":\"D1792435159956271105\",\"calDivisionAmount\":990,\"divisionProfit\":0.100000,\"receiverAlias\":\"B\",\"receiverGroupId\":100001,\"receiverId\":800002,\"recordId\":1008,\"state\":1}]"
},
"msg":"SUCCESS",
"sign":"ABA5F4300D536E10CCB1FC677847773D"
}
订单分账完结
1、调用此接口,可将订单剩余金额解冻给商户。
2、订单分账完结后,不可再次发起分账。
3、返回完结处理中状态时,可调用支付订单查询接口查询最终分账完结状态。
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/finish
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
支付订单号 | payOrderId | 否 | String(30) | P20160427210604000490 | 支付中心生成的支付订单号,与mchOrderNo二者传一即可 |
商户单号 | mchOrderNo | 否 | String(64) | 20160427210604000490 | 商户生成的支付单号,与payOrderId二者传一即可 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'mchNo': 'M1623997351',
'appId': '60cc3ba74ee0e6685f57eb1e',
'payOrderId': 'P202108271011463510002'
}
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
支付系统订单号 | payOrderId | 是 | Stirng | P92332433423442 | 支付系统订单号 |
系统分账批次号 | batchOrderId | 是 | String(30) | D20160427210604000490 | 系统分账批次号 |
分账完结状态 | state | 是 | int | 1 | 分账完结状态 1-成功, 2-失败,3-处理中 |
渠道错误码 | errCode | 否 | String | 1002 | 渠道返回错误码 |
渠道错误描述 | errMsg | 否 | String | ERROR | 渠道返回错误描述 |
返回示例数据
{
"code":0,
"data":{
"batchOrderId":"D1792435159956271105",
"state":"1",
},
"msg":"SUCCESS",
"sign":"ABA5F4300D536E10CCB1FC677847773D"
}
查询分账用户的可用余额
调用该接口实时查询渠道侧的分账用户的可用余额。
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/receiver/channelBalanceQuery
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
分账用户ID | receiverId | 是 | Long | 800021 | 分账用户ID(创建成功后返回) |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'receiverId': '800021',
'appId': '60cc3ba74ee0e6685f57eb1e'
}
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账用户ID | receiverId | 是 | int | 800021 | 分账用户ID |
余额 | balanceAmount | 是 | Long | 20 | 余额, 单位:分 |
返回示例数据
{
"code": 0,
"data": {
"balanceAmount": 0,
"receiverId": 800021
},
"msg": "SUCCESS",
"sign": "5F16138F18AC367165B60CD97BA8CA27"
}
对分账用户的渠道余额发起提现
调用该接口实时调起三方的提现接口, 将实时到结算银行卡。 建议调用前先调用余额查询接口。
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/receiver/channelBalanceCashout
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
商户号 | mchNo | 是 | String(64) | M1621873433953 | 商户号 |
应用ID | appId | 是 | String(64) | 60cc09bce4b0f1c0b83761c9 | 应用ID |
分账用户ID | receiverId | 是 | Long | 800021 | 分账用户ID(创建成功后返回) |
提现金额 | cashoutAmount | 是 | Long | 100 | 提现金额,单位分 |
请求时间 | reqTime | 是 | long | 1622016572190 | 请求接口时间,13位时间戳 |
接口版本 | version | 是 | String(3) | 1.0 | 接口版本号,固定:1.0 |
签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名值,详见签名算法 |
签名类型 | signType | 是 | String(32) | MD5 | 签名类型,目前只支持MD5或RSA2方式 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'receiverId': 800021,
'cashoutAmount': 10,
'appId': '60cc3ba74ee0e6685f57eb1e'
}
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回状态 | code | 是 | int | 0 | 0-处理成功,其他-处理有误,详见错误码 |
返回信息 | msg | 否 | String(128) | 签名失败 | 具体错误原因,例如:签名失败、参数格式校验错误 |
签名信息 | sign | 否 | String(32) | CCD9083A6DAD9A2DA9F668C3D4517A84 | 对data内数据签名,如data为空则不返回 |
返回数据 | data | 否 | String(512) | {} | 返回下单数据,json格式数据 |
data数据格式
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
分账用户ID | receiverId | 是 | int | 800021 | 分账用户ID |
状态 | state | 是 | byte | 1 | 提现状态: 1-成功, 0-失败 |
渠道错误码 | errCode | 否 | String | 1002 | 渠道返回错误码 |
渠道错误描述 | errMsg | 否 | String | ERROR | 渠道返回错误描述 |
返回示例数据
{
"code": 0,
"data": {
"receiverId": 801
"state": 1,
},
"msg": "SUCCESS",
"sign": "5F16138F18AC367165B60CD97BA8CA27"
}
余额提现记录查询 (未正式发布)
接口说明
适用对象:普通商户
特约商户
请求URL:https://pay.jeepay.vip/api/division/receiver/cashoutRecordQuery
请求方式:POST
请求类型:application/json
或 application/x-www-form-urlencoded
请求参数
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
receiverId | 800005 | String | 是 | 接收方ID |
reqTime | 1732088581033 | String | 是 | 时间戳 |
mchNo | M1723013954 | String | 是 | 商户号 |
appId | 66b31b433d7ad4ada9ac7f83 | String | 是 | 商户应用ID |
sign | 2EC014AFB7FF239AF1433686398AFBE6 | String | 是 | 签名值,详见签名算法 |
version | 1.0 | String | 是 | 接口版本号,固定:1.0 |
signType | MD5 | String | 是 | 签名类型,目前只支持MD5或RSA2方式 |
pageSize | 10 | int | 否 | 分页条数 默认20 |
pageNumber | 1 | int | 否 | 分页页码 默认1 |
请求示例数据
{
'version': '1.0',
'reqTime': '1622016572190',
'signType': 'MD5',
'sign': '1',
'receiverId': 800021,
'appId': '60cc3ba74ee0e6685f57eb1e',
'mchNo': 'M1000001',
'pageSize': 1,
'pageNumber': 1
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | 0 | Integer | 0-处理成功,其他-处理有误,详见错误码 |
data | - | Object | 返回提现记录,json格式数据 |
data.current | 1 | Integer | 当前页码 |
data.hasNext | false | Boolean | 是否有下一页 |
data.receiverId | 800005 | Integer | 接收方ID |
data.records | - | Array | 记录明细 |
data.records.ifCode | yeepay | String | 支付接口代码 |
data.records.mchOrderNo | e06d47135be94b57a093daa7c6c9e88a | String | 商户提现单号 |
data.records.errMsg | 无可结算的结算明细。 | String | 渠道支付错误描述 |
data.records.rid | C1856945042336866306 | String | 提现记录ID |
data.records.isvNo | V1682566503 | String | 服务商号 |
data.records.createdAt | 2024-11-14 14:19:33 | String | 创建时间 |
data.records.appId | 66b31b433d7ad4ada9ac7f83 | String | 商户应用ID |
data.records.state | 3 | Integer | 提现状态 结算状态: 0-提现单创建, 1-提现中, 2-提现成功, 3-提现失败 |
data.records.mchNo | M1723013954 | String | 商户号 |
data.records.updatedAt | 2024-11-14 14:19:34 | String | 更新时间 |
data.records.cashoutAmount | 155 | Integer | 申请提现金额,单位分 |
data.records.mchName | 易宝 | String | 商户名称 |
data.records.errCode | 400032 | String | 渠道支付错误码 |
data.records.channelSubMchId | 10090474424 | String | 渠道子商户号 |
data.total | 2 | Integer | 总条数 |
msg | SUCCESS | String | 具体错误原因,例如:签名失败、参数格式校验错误 |
sign | C75572E6D2AFE2ED35FA827049A29C1E | String | 对data内数据签名,如data为空则不返回 |
successTime | - | String | 提现成功时间 |
bankName | - | String | 提现银行名称 |
bankAccount | - | String | 提现账户 |
bankAccountName | - | String | 提现账户名称 |
remark | - | String | 备注信息 |
payOrderId | - | String | 支付订单号 |
channelRid | - | String | 渠道提现单ID |
返回示例数据
{
"code": 0,
"data": {
"current": 1,
"hasNext": false,
"receiverId": 800005,
"records": [
{
"ifCode": "yeepay",
"mchOrderNo": "e06d47135be94b57a093daa7c6c9e88a",
"errMsg": "无可结算的结算明细。",
"rid": "C1856945042336866306",
"isvNo": "V1682566503",
"createdAt": "2024-11-14 14:19:33",
"appId": "66b31b433d7ad4ada9ac7f83",
"state": 3,
"mchNo": "M1723013954",
"updatedAt": "2024-11-14 14:19:34",
"cashoutAmount": 155,
"mchName": "易宝",
"errCode": "400032",
"channelSubMchId": "10090474424"
}
],
"total": 2
},
"msg": "SUCCESS",
"sign": "C75572E6D2AFE2ED35FA827049A29C1E"
}