完结分账

应用场景

  • 1、不需要进行分账的订单,可直接调用本接口将订单的金额全部解冻给本商户
  • 2、调用多次分账接口后,需要解冻剩余资金时,调用本接口将剩余的分账金额全部解冻给特约商户
  • 3、已调用请求单次分账后,剩余待分账金额为零,不需要再调用此接口。

接口频率:30QPS

接口说明

请求Url https://api.mch.weixin.qq.com/secapi/pay/profitsharingfinish
是否需要证书 请求需要双向证书。 详见证书使用
请求方式 post
签名方式 HMAC-SHA256

请求参数

字段名 变量名 必填 类型 示例值 描述
商户号 mch_id string(32) 1900000100 微信支付分配的商户号
公众账号ID appid string(32) wx8888888888888888 微信分配的公众账号ID
随机字符串 nonce_str string(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 随机字符串,不长于32位。推荐随机数生成算法
签名 sign string(64)

C380BEC2BFD727A4B6845133519F3AD6C380BEC2BFD727A4B6845133519F3AD6 签名,详见签名生成算法
签名类型 sign_type string(32) HMAC-SHA256 签名类型,目前只支持HMAC-SHA256
微信订单号 transaction_id string(32) 4208450740201411110007820472 微信支付订单号
商户分账单号 out_order_no string(64) P20150806125346 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@ 
分账完结描述 description string(80) 分账已完成 分账完结的原因描述

举例如下:

<xml>
    <appid>wx2421b1c4370ec43b</appid>
    <mch_id>10000100</mch_id>
    <nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str> 
    <out_order_no>P20150806125346</out_order_no>
    <transaction_id>4006252001201705123297353072</transaction_id>
    <sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
<sign_type>HMAC-SHA256</sign_type>
<description>分账已完成</description>
</xml>

返回结果

字段名 变量名 必填 类型 示例值 描述
返回状态码 return_code String(16) SUCCESS

SUCCESS/FAIL 此字段是通信标识,非交易标识

返回信息 return_msg String(128) 参数格式校验错误

返回信息,如非空,为错误原因

以下字段在return_code为SUCCESS的时候有返回

字段名 变量名 必填 类型 示例值 描述
业务结果 result_code

string(32) SUCCESS SUCCESS:分账完结请求接收成功,结果通过分账查询接口查询 FAIL :提交业务失败
错误代码 err_code string(32) SYSTEMERROR 列表详见错误码列表
错误代码描述 err_code_des String(128) 系统超时 结果信息描述
商户号 mch_id string(32) 1900000100 调用接口时提供的商户号
公众账号ID appid string(32) wx8888888888888888 调用接口提供的公众账号ID
随机字符串 nonce_str string(32) 5K8264ILTKCH16CQ2502SI8ZNMTM67VS 微信返回的随机字符串
签名 sign string(64) C380BEC2BFD727A4B6845133519F3AD6 微信返回的签名,详见签名算法

以下字段在return_code 和result_code都为SUCCESS的时候有返回

字段名 变量名 必填 类型 示例值 描述
微信订单号 transaction_id string(32) 4208450740201411110007820472 微信支付订单号
商户分账单号 out_order_no string(64) P20150806125346 商户系统内部的分账单号,在商户系统内部唯一(单次分账、多次分账、完结分账应使用不同的商户分账单号),同一分账单号多次请求等同一次。只能是数字、大小写字母_-|*@ 
微信分账单号 order_id string(64) 3008450740201411110007820472 微信分账单号,微信系统返回的唯一标识

举例如下:

<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
  <return_msg><![CDATA[OK]]></return_msg>
<result_code><![CDATA[SUCCESS]]></result_code>
   <mch_id>10000100</mch_id>
<appid>wx2421b1c4370ec43b</appid>
<nonce_str>6cefdb308e1e2e8aabd48cf79e546a02</nonce_str> 
<out_order_no>P20150806125346</out_order_no>
<transaction_id>4006252001201705123297353072</transaction_id>
<order_id>3008450740201411110007820472</order_id>
<sign>FE56DD4AA85C0EECA82C35595A69E153</sign>
</xml>

错误码

名称 描述 原因 解决方案
SYSTEMERROR 接口返回错误 系统超时 请不要更换商户分账单号,请使用相同参数再次调用API。否则可能造成资金损失
INVALID_TRANSACTIONID 无效的微信支付订单号 请求参数未按指引进行填写 请求参数错误,检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR 参数错误 请求参数未按指引进行填写 请求参数错误,请重新检查再调用分账完结接口
INVALID_REQUEST 请求不合法 参数中APPID或 MCHID不存在等 请检查请求参数
FREQUENCY_LIMITED 频率限制 请求过多被频率限制 该笔请求未受理,请降低频率后原单重试,请勿更换商户分账单号
ORDER_NOT_READY 订单处理中 订单处理中,暂时无法处理分账完结请求 订单处理中,暂时无法处理分账完结请求,请稍后再试
OPENID_MISMATCH openid错误 openid与appid不匹配 请检查openid是否正确
NOT_SHARE_ORDER 非分账订单 不是分账订单 无法分账 下单时请用分账的合适参数
AMOUNT_OVERDUE 可分余额不足 订单剩余可分账金额为零 请检查请求参数