1. 3、业务指引
  • 1、接入指引
    • 1.1 阅读人员与名词解释
    • 1.2版本发布说明
    • 1.3接入准备
    • 1.4接入指引
  • 2、平台规范
    • 2.1接口格式定义
    • 2.2 加签验签说明与代码示例
    • 2.3 参数说明
    • 2.4上线前检查清单
  • 3、业务指引
    • 3.1 商户入网业务接入指引
    • 3.2 余额分账业务接入指引
  • 4、API列表
    • 4.1商户入网类接口
      • 4.1.1 图片上传接口
        • 4.1.1.1 公共文件上传(进件用上传临时文件)
      • 4.1.2 商户入网与配置
        • 4.1.2.1 商户添加
        • 4.1.2.2 商户更新
        • 4.1.2.3 收单商户入网
        • 4.1.2.4 收单商户更新
        • 4.1.2.5 通道添加
        • 4.1.2.6 通道变更
        • 4.1.2.7 商户详情查询
        • 4.1.2.8 收单商户更新详情查询
        • 4.1.2.9 分账开通
        • 4.1.2.10 分账变更
        • 4.1.2.11 分账开通结果查询
        • 4.1.2.12 分账关系绑定
        • 4.1.2.13 分账关系解绑
        • 4.1.2.14 微信关注配置
        • 4.1.2.15 微信关注配置查询
        • 4.1.2.16 实名认证申请
        • 4.1.2.17 实名认证申请状态查询
        • 4.1.2.18 实名认证授权状态结果查询
        • 4.1.2.19 商户入网通知
    • 4.2聚合支付交易类接口
    • 4.3订单分账类接口
    • 4.4余额分账类接口
      • 4.4.2 余额查询接口
        • 4.4.2.1 余额查询
      • 4.4.1 余额分账相关接口
        • 4.4.1.1 B2B转账
        • 4.4.1.2 转账查询
      • 4.4.3 提现相关接口
        • 4.4.3.1 提现
        • 4.4.3.2 提现查询
        • 4.4.3.3 查询提现银行卡
    • 4.5信用付(先享后付)类接口
    • 4.6大额支付类接口
    • 4.7 资产营销类接口
      • 4.7.1 营销资产核销开放接口
        • 4.7.1.1 资产预查核验
        • 4.7.1.2 资产交易(核销)
        • 4.7.1.3 资产交易(核销)查询
        • 4.7.1.4 资产交易(核销)撤销
        • 4.7.1.5 资产交易(核销)撤销查询
        • 4.7.1.6 资产余额查询
        • 4.7.1.7 资产交易对账单拉取
        • 4.7.1.8 付款码订单轮询查询
        • 4.7.1.9 付款码订单结果通知
      • 4.7.2 品牌商户专用营销资产核销接口
        • 4.7.2.1 资产预查核验(品牌商户)
        • 4.7.2.2 资产交易(核销)(品牌商户)
        • 4.7.2.3 资产交易(核销)查询(品牌商户)
        • 4.7.2.4 资产交易(核销)撤销(品牌商户)
        • 4.7.2.5 资产交易(核销)撤销查询(品牌商户)
        • 4.7.2.6 资产余额查询(品牌商户)
        • 4.7.2.7 资产交易对账单拉取(品牌商户)
        • 4.7.2.8 付款码订单轮询查询(品牌商户)
        • 4.7.2.9 付款码订单结果通知(品牌商户)
    • 4.8辅助类接口
      • 4.8.1 开放平台API示例控制器
        • 4.8.1.1 参数加密示例
      • 4.8.2 配置获取类接口
        • 4.8.2.1 获取MCC行业类目树
        • 4.8.2.2 获取区域列表(三级联动查询)
        • 4.8.2.3 获取银行总行列表
        • 4.8.2.4 获取银行支行列表
        • 4.8.2.5 获取易宝MCC行业类目树
        • 4.8.2.6 获取易生MCC行业类目树
        • 4.8.2.7 获取易生支付宝微信MCC映射关系列表
        • 4.8.2.8 获取平安银行MCC映射关系列表
      • 4.8.3 交易投诉处理类接口
        • 4.8.3.1 投诉单分页查询
        • 4.8.3.2 投诉单详情查询
        • 4.8.3.3 回复投诉用户
        • 4.8.3.4 完结投诉处理
        • 4.8.3.5 投诉凭证图片上传
        • 4.8.3.6 投诉凭证图片查看
    • 4.9银行账户与分账类接口
      • 4.9.1 EBK账户类
        • 4.9.1.1 EBK账户注册
        • 4.9.1.2 EBK账户基本信息查询
        • 4.9.1.3 EBK账户绑定提现账户
        • 4.9.1.4 EBK账户解绑提现账户
      • 4.9.2 EBK动账交易类
        • 4.9.2.1 账户转账
        • 4.9.2.2 EBK账户提现
        • 4.9.2.3 批量清分
      • 4.9.3 EBK交易查询类
        • 4.9.3.1 转账状态查询
        • 4.9.3.2 EBK账户余额查询
        • 4.9.3.3 提现状态查询
        • 4.9.3.4 清分状态查询
    • 4.1.2 商户入网与配置
  • F.附录
  • FAQ
  1. 3、业务指引

3.2 余额分账业务接入指引

余额分账业务接入指引#

本文档为开放平台余额分账模块的业务接入指引,涵盖 B2B 转账、提现、余额查询等功能。
接口路径前缀:/v1/openpay/account。
转账和提现接口为 异步 处理:提交后通过查询接口获取处理结果,也可配置异步回调通知。

一、功能概览#

余额分账模块提供以下核心能力:
功能说明接口编号
B2B 转账商户钱包余额之间的转账4.4.1.1
转账查询查询转账订单状态和结果4.4.1.2
余额查询查询商户钱包账户余额4.4.2.1
提现商户钱包余额提现至银行卡4.4.3.1
提现查询查询提现订单状态和结果4.4.3.2
查询提现银行卡查询已绑定的提现银行卡列表4.4.3.3
前置条件:使用余额分账功能前,商户需已完成入网并开通余额分账功能(分账模式 splitMode=2)。

二、公共说明#

2.1 请求格式#

所有接口统一使用 OpenApiRequest<T> 包装:
{
  "reqBody": {
    // 业务请求参数
  }
}

2.2 响应格式#

所有接口统一使用 OpenApiResponse<T> 包装:
{
  "code": "SUCCESS",
  "msg": "成功",
  "data": {
    // 业务响应数据
  }
}

2.3 认证与商户号(merchantNo)规则#

所有接口需携带 API Key 进行认证(@SaCheckApiKey)。
merchantNo 处理规则:
当前商户类型merchantNo 是否必填说明
普通商户(NORMAL)否系统从登录上下文自动获取,调用方无需传入
品牌商户(BRAND)是传入目标下属商户号,系统校验归属关系
服务商商户(PROXY)是传入目标下属商户号,系统校验归属关系
归属关系校验:目标商户的 merchantPno 必须等于当前登录商户号,否则拒绝请求。
即:品牌/服务商商户只能代操作其下属商户的业务。

2.4 金额单位#

所有金额字段统一使用 分 为单位。

2.5 幂等控制#

转账和提现接口使用 bizFlowNo(商户请求流水号)进行幂等控制:
同一商户号下 2 天内 不允许重复
重复提交将直接拒绝,返回"bizFlowNo已存在"

三、B2B 转账#

3.1 流程说明#

B2B 转账用于实现商户钱包余额之间的资金划转:
1.
调用方发起转账请求(接口编号 4.4.1.1),指定付款方、收款方和转账金额。
2.
系统同步调用通道完成转账,返回提交结果。
3.
转账成功后系统自动生成转出方(OUT)和转入方(IN)两条流水记录。
4.
如配置了 notifyUrl,订单状态变更时系统会异步回调通知。
5.
通过转账查询接口(接口编号 4.4.1.2)查询最终结果。
注意:本接口为同步接口,应答中 status 为 SUCCESS 表示转账已成功,FAIL 表示失败。

3.2 接口列表#

接口编号接口路径方法名说明
4.4.1.1POST /v1/openpay/account/transfertransferB2B 转账
4.4.1.2POST /v1/openpay/account/transfer/querytransferQuery转账查询

3.3 转账请求参数(4.4.1.1)#

字段类型必填说明
merchantNoString条件必填商户号。普通商户无需传入;品牌/服务商商户必填(目标下属商户号)
bizFlowNoString是商户请求流水号,2天内唯一
fromMerchantNoString是付款方商户号
toMerchantNoString是收款方商户号
orderAmountLong是转账金额(分),必须大于 0
usageString否转账用途
notifyUrlString否异步通知地址,订单状态变更时回调

3.4 转账响应参数#

字段类型说明
bizFlowNoString商户请求流水号
orderNoString收呗订单号
statusString平台状态,见枚举表
orderAmountLong转账金额(分),仅成功时返回
feeLong手续费(分)
trxTimeString交易时间,格式 yyyy-MM-dd HH:mm:ss
accountTimeString入账时间,格式 yyyy-MM-dd HH:mm:ss
failReasonString失败原因,仅 status=FAIL 时返回

3.5 转账查询请求参数(4.4.1.2)#

字段类型必填说明
merchantNoString条件必填商户号。普通商户无需传入;品牌/服务商商户必填(目标下属商户号)
bizFlowNoString二选一商户请求流水号
orderNoString二选一收呗订单号

3.6 转账查询响应参数#

字段类型说明
bizFlowNoString商户请求流水号
orderNoString收呗订单号
statusString平台状态,见枚举表
orderAmountLong订单金额(分)
feeLong手续费(分)
trxTimeString交易时间
accountTimeString入账时间
fromMerchantNoString付款方商户号
toMerchantNoString收款方商户号
failReasonString失败原因,仅失败时返回

3.7 时序图#


四、余额查询#

4.1 流程说明#

余额查询用于获取商户钱包账户的可用余额信息:
1.
调用余额查询接口(接口编号 4.4.2.1),查询当前商户的账户余额。
2.
返回余额(分)和账户状态。

4.2 接口列表#

接口编号接口路径方法名说明
4.4.2.1POST /v1/openpay/account/balance/queryqueryBalance余额查询

4.3 请求参数#

无需传入业务参数,merchantNo 由系统自动获取。

4.4 响应参数#

字段类型说明
balanceLong余额(分)
accountStatusString账户状态,见账户状态枚举表

4.5 时序图#


五、提现#

5.1 流程说明#

提现用于将商户钱包余额提现至绑定的银行卡账户:
1.
调用方发起提现请求(接口编号 4.4.3.1),指定提现金额和结算银行卡。
2.
未指定结算卡号时,默认使用商户结算账户卡号。
3.
系统调用通道完成提现,返回提交结果。
4.
如配置了 notifyUrl,订单状态变更时系统会异步回调通知。
5.
通过提现查询接口(接口编号 4.4.3.2)查询最终结果。
注意:本接口为异步接口,应答仅代表提现请求已提交至通道,最终结果请通过查询接口确认。

5.2 接口列表#

接口编号接口路径方法名说明
4.4.3.1POST /v1/openpay/account/withdrawwithdraw提现
4.4.3.2POST /v1/openpay/account/withdraw/querywithdrawQuery提现查询
4.4.3.3POST /v1/openpay/account/withdraw/cardswithdrawCards查询提现银行卡

5.3 提现请求参数(4.4.3.1)#

字段类型必填说明
merchantNoString条件必填商户号。普通商户无需传入;品牌/服务商商户必填(目标下属商户号)
bizFlowNoString是商户请求流水号,2天内唯一
orderAmountLong是提现金额(分),必须大于 0
bankAccountNoString否提现银行卡号,未传时取商户结算账户卡号
remarkString否备注
notifyUrlString否异步通知地址,订单状态变更时回调

5.4 提现响应参数#

字段类型说明
bizFlowNoString商户请求流水号
orderNoString收呗订单号
statusString平台状态,见枚举表
trxTimeString交易时间,格式 yyyy-MM-dd HH:mm:ss
accountTimeString入账时间,格式 yyyy-MM-dd HH:mm:ss
failReasonString失败原因,仅 status=FAIL 时返回

5.5 提现查询请求参数(4.4.3.2)#

字段类型必填说明
merchantNoString条件必填商户号。普通商户无需传入;品牌/服务商商户必填(目标下属商户号)
bizFlowNoString二选一商户请求流水号
orderNoString二选一收呗订单号

5.6 提现查询响应参数#

字段类型说明
bizFlowNoString商户请求流水号
orderNoString收呗订单号
statusString平台状态,见枚举表
orderAmountLong订单金额(分)
feeLong手续费(分)
trxTimeString交易时间
accountTimeString入账时间
isReversedBoolean是否有退返标记
failReasonString失败原因,仅失败时返回

5.7 查询提现银行卡(4.4.3.3)#

通过本接口可查询商户已绑定的提现银行卡列表,供提现时选择结算账户。
请求参数:无需传入业务参数。
响应:返回银行卡列表(包含卡号、银行名称等信息)。

5.8 时序图#


六、异步回调通知#

6.1 通知机制#

当订单状态发生变更时,系统会向调用方传入的 notifyUrl 发起 POST 回调通知。回调采用统一请求体(OpenApiRequest)+ RSA 签名格式,与开放平台 API 请求格式一致。

6.2 通知触发时机#

场景触发条件
同步返回提交接口同步返回终态(SUCCESS/FAIL)时立即推送
主动查询查询接口检测到状态从非终态 → 终态时推送
异步回调通道异步回调到达时推送

6.3 重试策略#

推送失败后自动重试,采用指数退避:1分钟 → 5分钟 → 30分钟 → 2小时 → 6小时,最多重试 5 次。对接方返回 success 视为推送成功。

6.4 通知报文格式#

回调报文采用统一请求体包装,业务字段位于 reqBody 中:
{
  "requestId": "请求ID(用于问题追踪)",
  "timestamp": "时间戳(毫秒)",
  "nonce": "随机字符串(16-36位)",
  "sign": "RSA签名值",
  "reqBody": { ... }
}
转账回调 reqBody:
字段类型必返回说明
bizFlowNoString是商户请求流水号
channelOrderNoString是通道订单号
bizOrderNoString是业务订单号
merchantNoString是商户号
orderAmountLong是转账金额(分)
feeLong是手续费(分)
orderStatusInteger是状态码:0=处理中,1=成功,2=失败
statusString是PROCESSING / SUCCESS / FAIL
bizTypeString是固定值 transfer
payerMerchantNoString否付款方商户号
payerMerchantNameString否付款方商户名称
payeeMerchantNoString否收款方商户号
payeeMerchantNameString否收款方商户名称
trxTimeString否交易时间,仅成功时返回
accountTimeString否入账时间,仅成功时返回
failReasonString否失败原因,仅失败时返回
提现回调 reqBody:
字段类型必返回说明
bizFlowNoString是商户请求流水号
channelOrderNoString是通道订单号
bizOrderNoString是业务订单号
merchantNoString是商户号
orderAmountLong是提现金额(分)
feeLong是手续费(分)
orderStatusInteger是状态码:0=处理中,1=成功,2=失败
statusString是PROCESSING / SUCCESS / FAIL
bizTypeString是固定值 withdraw
trxTimeString否交易时间,仅成功时返回
accountTimeString否入账时间,仅成功时返回
failReasonString否失败原因,仅失败时返回
报文示例(转账成功):
{
  "requestId": "cb-20260820-001",
  "timestamp": "1755676200000",
  "nonce": "a1b2c3d4e5f6g7h8",
  "sign": "MIIEvgIBADANBgkqhkiG9w0BAQEFA...",
  "reqBody": {
    "bizFlowNo": "TF20260820001",
    "channelOrderNo": "YE20260820123456789",
    "bizOrderNo": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "merchantNo": "M100001",
    "orderAmount": 100000,
    "fee": 10,
    "orderStatus": 1,
    "status": "SUCCESS",
    "bizType": "transfer",
    "payerMerchantNo": "M100001",
    "payerMerchantName": "付款方公司",
    "payeeMerchantNo": "M100002",
    "payeeMerchantName": "收款方公司",
    "trxTime": "2026-08-20 14:30:00",
    "accountTime": "2026-08-20 14:30:05"
  }
}

6.5 验签#

对接方需使用平台 RSA 公钥对回调通知进行验签,确保通知来源可信。验签步骤:
1.
提取外层 JSON 中的 sign 字段
2.
将剩余字段按 key ASCII 升序排列,拼接为 key1=value1&key2=value2&...(空值不参与签名,嵌套对象需平铺)
3.
对拼接字符串做 MD5 摘要
4.
使用平台公钥对 sign 进行 RSA 验签
对接方可复用已有的 API 签名验签工具(OpenApiSignKit.verify)。

6.6 通知确认#

调用方收到通知后需返回字符串 success(不区分大小写),系统将标记推送成功。若未返回 success,系统将按重试策略继续推送。对接方需根据 reqBody.bizFlowNo + reqBody.status 做幂等处理。
详细的回调接口文档请参见《转账提现回调通知接口文档》。

七、核心枚举速查#

7.1 转账状态(SbTransferStatusEnum)#

状态码说明
PROCESSING处理中
CHANNEL_ACCEPTED通道已受理
SUCCESS转账成功
FAIL转账失败

7.2 提现状态(SbWithdrawStatusEnum)#

状态码说明
PROCESSING处理中
CHANNEL_ACCEPTED通道已受理
SUCCESS提现成功
FAIL提现失败
REFUNDED已退返

7.3 账户状态(AccountStatusEnum)#

状态码说明
INIT未激活
NORMAL正常
FROZEN冻结
CANCELLED已注销

附录:接口总览#

Open API 余额分账接口索引#

接口编号模块接口路径说明
4.4.1.1转账/v1/openpay/account/transferB2B 转账
4.4.1.2转账/v1/openpay/account/transfer/query转账查询
4.4.2.1余额/v1/openpay/account/balance/query余额查询
4.4.3.1提现/v1/openpay/account/withdraw提现
4.4.3.2提现/v1/openpay/account/withdraw/query提现查询
4.4.3.3提现/v1/openpay/account/withdraw/cards查询提现银行卡

注意事项#

1.
merchantNo 规则:普通商户无需传入,系统自动获取;品牌/服务商商户必须传入目标下属商户号,系统校验归属关系(详见 2.3 节)。
2.
bizFlowNo 唯一性:同一商户号下 2 天内不允许重复,建议调用方使用带业务含义的唯一流水号(如 业务前缀_日期_自增序号)。
3.
手续费:转账和提现可能产生手续费,具体金额以查询接口返回为准。
4.
提现退返:提现可能因银行原因退返,查询接口通过 isReversed 字段标识,状态为 REFUNDED。
5.
异步通知可靠性:建议调用方同时使用主动查询接口作为兗底,不应完全依赖异步通知。
修改于 2026-08-20 07:18:41
上一页
3.1 商户入网业务接入指引
下一页
4.1.1.1 公共文件上传(进件用上传临时文件)
Built with