API字典 / 分账 / 分账标记API

解冻剩余资金API

最新更新时间：2022.08.04 版本说明

不需要进行分账的订单，可直接调用本接口将订单的金额全部解冻给订单出资方账户（原订单资金结算账户）；调用分账接口后，需要解冻剩余资金时，可调用本接口将剩余的未分账金额全部解冻给订单出资方账户。

注意：

• 此接口采用异步处理模式，即在接收到商户请求后，会先受理请求再异步处理，最终的分账结果可以通过查询分账接口获取；

• 该接口返回成功后，解冻出境的金额将和非分账订单金额一起参与轧差结算，与商户的结算合同中的相关结算周期、起结点等提现规则保持一致；

• 出资方指和微信支付发生实际结算、资金入账的商户；在境外机构商模式下为机构商户、在服务商模式下为二级商户。

1. 接口说明

适用对象：直连模式机构模式

请求URL：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/orders/unfreeze

请求方式：POST

Path指该参数为路径参数

Query指该参数为URL参数

Body指该参数需在请求JSON传参

2. 请求参数

参数名	变量	类型[长度限制]	必填	描述
二级商户号	sub_mchid	string[1, 32]	否	Body微信支付分配的商户号，请与微信支付订单的二级商户号保持一致。（直连商户不需要，服务商/机构模式下必填）示例值：1900000109
微信支付订单号	transaction_id	string[1, 32]	是	Body微信支付订单号示例值：4208450740201411110007820472
商户分账单号	out_order_no	string[1, 64]	是	Body商户系统内部的分账单号，在商户系统内部唯一，同一分账单号多次请求等同一次。只能是数字、大小写字母_-。注：该单号用于标识商户侧发起的不同分账指令请求（包括请求分账API/解冻剩余资金API）。若需要对同一笔微信支付订单进行多次资金分发处理，请注意更换【商户分账单号】后再发起调用，否则会被微信支付服务视为同一请求重入。示例值：P20150806125346
分账描述	description	string[1, 80]	是	Body分账的原因描述，分账账单中需要体现示例值：解冻全部剩余资金

请求示例

JSON


{
  "description": "解冻全部剩余资金",
  "out_order_no": "P20150806125346",
  "sub_mchid": "1900000109",
  "transaction_id": "4208450740201411110007820472"
}

3. 返回参数

参数名

变量

类型[长度限制]

必填

描述

二级商户号

sub_mchid

string[1, 32]

否

微信支付分配的商户号
示例值：1900000109

微信支付订单号

transaction_id

string[1, 32]

是

微信支付订单号
示例值：4208450740201411110007820472

商户分账单号

out_order_no

string[1, 64]

是

商户分账单号，同请求入参。
示例值：P20150806125346

微信分账单号

order_id

string[1, 64]

是

微信分账单号，微信系统返回的唯一标识。
示例值：3008450740201411110007820472

分账单状态

state

string

是

分账单状态（每个接收方的分账结果请查看receivers中的result字段）。
PROCESSING - 处理中，
FINISHED - 分账完成，
示例值：FINISHED

分账接收方列表

receivers

array

是

分账接收方列表
商户在发起分账请求或解冻剩余资金请求时，对同一笔订单可分给多个接收方（包括解冻给出资方），分账明细描述了每笔分给一个接收方的资金的状态。

参数名	变量	类型[长度限制]	必填	描述
分账币种	currency	string[3, 3]	是	分账币种，同请求入参。示例值：CNY
分账金额	amount	int	是	分账金额，同请求入参。示例值：100
分账描述	description	string[1, 80]	是	商户传入的分账描述，同请求入参。示例值：分给商户1900000110
接收方类型	type	string	是	接收方类型，同请求入参。 MERCHANT_ID - 商户号， PERSONAL_OPENID - 个人OpenID，由商户APPID转换得到 PERSONAL_SUB_OPENID - 是个人Sub_OpenID，由二级商户APPID转换得到示例值：MERCHANT_ID
接收方账号	account	string[1, 64]	是	接收方账号，同请求入参。示例值：1900000109
分账明细结果	result	string	是	每一笔分账明细转账的结果。 PENDING - 待分账， SUCCESS - 分账成功， CLOSED - 已关闭，示例值：SUCCESS
分账明细失败原因	fail_reason	string	否	分账明细失败原因。在分账明细结果为"CLOSED"时才会被设置。 NO_RELATION - 分账关系已解除， SUB_MERCHANT_FRONEN - 二级商户被冻结， MCH_CONTRACT_SETTLE_OFF - 商户结算合同为关闭结算状态， MCH_CONTRACT_FROZEN - 商户结算合同被冻结， ACCOUNT_ABNORMAL - 分账接收账户异常， RECEIVER_HIGH_RISK - 高风险接收方， RECEIVER_REAL_NAME_NOT_VERIFIED - 接收方未实名， NO_AUTH - 分账权限已解除， DEFAULT_ERROR - 默认错误，示例值：ACCOUNT_ABNORMAL
分账明细创建时间	create_time	string[1, 64]	是	分账明细创建时间，遵循RFC3339标准格式示例值：2015-05-20T13:29:35.120+08:00
分账明细完成时间	finish_time	string[1, 64]	否	分账明细完成时间，遵循RFC3339标准格式。在分账明细结果为"SUCCESS"或"CLOSED"时才会被设置。示例值：2015-05-20T13:29:35.120+08:00
分账明细单号	detail_id	string[1, 64]	是	微信分账明细单号，每笔分账业务执行的明细单号。示例值：36011111111111111111111
分账明细类型	detail_type	string	是	分账明细分为两类，包括分出给其他接收方和解冻给出资方。可由该字段来区分，若明细类型为UNFREEZE_TO_SPONSOR(解冻给出资方)时，分账明细中还会返回出资方结算币种、结算金额、汇率值等信息。 DISTRIBUTE_TO_OTHERS - 分出给其他接收方， UNFREEZE_TO_SPONSOR - 解冻给出资方出境，示例值：DISTRIBUTE_TO_OTHERS
出资方结算币种	settlement_currency	string[3, 3]	否	出资方的结算币种，明细类型为UNFREEZE_TO_SPONSOR(解冻给出资方)时该字段才会被设置。示例值：HKD
出资方结算金额	settlement_amount	int	否	该笔明细通过换汇后最终结算给出资方的金额，采用最小币种单位。示例值：110
汇率值	rate	int	否	分账币种与结算币种的兑换比例乘以10的8次方即为此值。若分账币种与结算币种均为人民币，则兑换比值为1，汇率值为100,000,000; 若结算币种为美元，假设美元兑换人民币的比例为6.5，则汇率值为650,000,000。示例值：81000000

收起

返回示例

正常示例


{
    "order_id": "7100000751202203238029563456088",
    "out_order_no": "P20150806125346",
    "receivers": [
      {
        "account": "999952224",  # 出资方商户号
        "amount": 995,
        "create_time": "2022-03-23T17:59:23+08:00",
        "currency": "CNY",
        "description": "解冻全部剩余资金",
        "detail_id": "7200000751202203238029563456171",
        "detail_type": "UNFREEZE_TO_SPONSOR",
        "rate_value": 83640300,
        "result": "PENDING",
        "settlement_amount": 1189,
        "settlement_currency": "HKD",
        "type": "MERCHANT_ID"
      }
    ],
    "state": "PROCESSING",
    "sub_mchid": "1900000109",
    "transaction_id": "4208450740201411110007820472"
  }

4. 错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	分账请求中的商户信息与原支付订单商户信息不一致	请仔细检查订单号是否填错、二级子商户是否未填或填错
400	INVALID_REQUEST	该订单不支持分账	请检查微信支付订单号是否填错，并确认在调用下单API之前执行调用分账标记API成功
403	NO_AUTH	商户未签约境外分账产品能力	请参考产品流程和接入准备，确认商户具有分账权限后再发起请求
403	NO_AUTH	商户已开通分账产品能力，等待生效中(一般为第二天才生效)	开通分账产品能力当天不能发起分账，请等待第二天后发起请求
403	NO_AUTH	商户父子关系不存在，请使用正确的二级商户号发起请求	请检查二级商户号(sub_mchid)是否填写正确
400	INVALID_REQUEST	商户解冻剩余资金时指令(out_order_no)已存在，且明细内容不符合预期	若为不同分账请求，请更换外部指令单号(out_order_no)再发起分账请求
403	NOTENOUGH	请求分账时校验到可分金额不足	可通过【查询剩余可分金额API】来获取订单当前的可分金额
500	SYSYTEMERROR	商户发起分账请求指定的微信支付订单资金冻结流程还未完成，请稍后重试	用户支付完成后即会触发对该笔分账支付单的资金冻结流程，建议商户可在3~5min后重试

页面导航

语言

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

支付产品

资金类产品

其他产品

解冻剩余资金API

1. 接口说明

2. 请求参数

请求示例

3. 返回参数

返回示例

4. 错误码