最新更新時(shí)間:2022.06.14 版本說(shuō)明
微信訂單支付成功后,商戶發(fā)起分賬請(qǐng)求,將結(jié)算后的資金分到分賬接收方。
? 對(duì)同一筆訂單最多能發(fā)起50次分賬請(qǐng)求,每次請(qǐng)求最多分給50個(gè)接收方;
? 此接口采用異步處理模式,即在接收到商戶請(qǐng)求后,會(huì)先受理請(qǐng)求再異步處理,最終的分賬結(jié)果可以通過查詢分賬結(jié)果API獲取;
? 此接口支持商戶對(duì)同一筆訂單發(fā)起多次分賬,請(qǐng)仔細(xì)閱讀請(qǐng)求參數(shù)中的unfreeze_unsplit字段描述,執(zhí)行相應(yīng)操作(可參考文檔后補(bǔ)充的調(diào)用樣例);
? 通過本接口解凍給出資方執(zhí)行出境的金額,將和非分賬訂單金額一起參與軋差結(jié)算,與商戶的結(jié)算合同中的結(jié)算周期、起結(jié)點(diǎn)等提現(xiàn)規(guī)則保持一致;
? 出資方指和微信支付發(fā)生實(shí)際結(jié)算、資金入賬的商戶;在境外機(jī)構(gòu)商模式下為機(jī)構(gòu)商戶、在服務(wù)商模式下為二級(jí)商戶。
? 商戶上送敏感信息時(shí)使用微信支付平臺(tái)公鑰加密,證書序列號(hào)包含在請(qǐng)求HTTP頭部的Wechatpay-Serial,詳見接口規(guī)則
適用對(duì)象:直連模式 機(jī)構(gòu)模式
請(qǐng)求URL:https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/orders
請(qǐng)求方式:post
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請(qǐng)求JSON傳參
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
二級(jí)商戶號(hào) | sub_mchid | string[1, 32] | 否 | body微信支付分配的商戶號(hào),請(qǐng)與微信支付訂單的二級(jí)商戶號(hào)保持一致。(直連商戶不需要,服務(wù)商/機(jī)構(gòu)模式下必填) 示例值:1900000109 |
公眾賬號(hào)ID | appid | string[1, 32] | 否 | body與機(jī)構(gòu)商戶綁定的公眾賬號(hào)ID(AppID),平臺(tái)會(huì)校驗(yàn)該字段與機(jī)構(gòu)商之間是否存在有效綁定關(guān)系。分賬接收方類型包含“PERSONAL_OPENID”時(shí)必填。 示例值:wx8888888888888888 |
二級(jí)商戶公眾賬號(hào)ID | sub_appid | string[1, 32] | 否 | body機(jī)構(gòu)服務(wù)商為二級(jí)商戶配置綁定的公眾賬號(hào)ID,平臺(tái)會(huì)校驗(yàn)機(jī)構(gòu)服務(wù)商、二級(jí)商戶和SubAppID之間的有效綁定關(guān)系。分賬接收方類型包含“PERSONAL_SUB_OPENID”時(shí)必填。 示例值:wx8888888888888889 |
微信支付訂單號(hào) | transaction_id | string[1, 32] | 是 | body微信支付訂單號(hào) 示例值:4208450740201411110007820472 |
商戶分賬單號(hào) | out_order_no | string[1,64] | 是 | body商戶系統(tǒng)內(nèi)部的分賬單號(hào),在商戶系統(tǒng)內(nèi)部唯一。只能是數(shù)字、大小寫字母_-。 注:該單號(hào)用于標(biāo)識(shí)商戶側(cè)發(fā)起的不同分賬指令請(qǐng)求(包括請(qǐng)求分賬API/解凍剩余資金API)。 若需要對(duì)同一筆微信支付訂單進(jìn)行多次資金分發(fā)處理,請(qǐng)注意更換【商戶分賬單號(hào)】后再發(fā)起調(diào)用,否則會(huì)被微信支付服務(wù)視為同一請(qǐng)求重入。 示例值:P20150806125346 |
+ 分賬接收方列表 | receivers | array[1,50] | 否 | body分賬接收方列表,若unfreeze_unsplit=false,則可以設(shè)置出資商戶作為分賬接受方,否則會(huì)拒絕分賬請(qǐng)求。最多可有50個(gè)分賬接收方。 |
是否解凍剩余未分賬資金 | unfreeze_unsplit | boolean | 是 | body1、如果為true,該筆訂單剩余未分賬的金額會(huì)解凍回分賬出資方商戶,并發(fā)起購(gòu)匯出境; 2、如果為false,該筆訂單剩余未分賬的金額不會(huì)解凍回分賬出資方商戶,可以對(duì)該筆訂單再次進(jìn)行分賬。 示例值:true |
一筆支付訂單金額10元,結(jié)算扣除手續(xù)費(fèi)后剩余待分賬金額為9.95元,此時(shí)商戶可通過【分賬請(qǐng)求API】發(fā)起分賬請(qǐng)求
a. 指定分給合作商戶(2480248971)0.99元
b. 分給合作用戶(of8YZ9LPmjDmYAddobIvtTdQQjR8)0.99元
c. 同時(shí)通過設(shè)置unfreeze_unsplit為true,將剩余金額解凍給出資方執(zhí)行購(gòu)匯出境。來(lái)完成對(duì)本次訂單的資金分發(fā)。
{
"appid": "wx7bc98d929da735fe",
"out_order_no": "MCH13SFDG234155321146",
"receivers": [
{
"account": "2480248971",
"amount": 99,
"currency": "CNY",
"description": "分給xxx商戶-10%",
"type": "MERCHANT_ID"
},
{
"account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
"amount": 99,
"currency": "CNY",
"description": "分給xxx用戶-10%",
"type": "PERSONAL_OPENID"
}
],
"sub_mchid": "999968479",
"transaction_id": "4200000012202203235765130087",
"unfreeze_unsplit": true
}
一筆支付訂單金額200元,結(jié)算扣除手續(xù)費(fèi)后剩余待分賬金額為199元,商戶希望先對(duì)其中50%的資金(100元)進(jìn)行分賬處理,此時(shí)商戶可通過【分賬請(qǐng)求API】發(fā)起分賬請(qǐng)求
a. 指定分給合作商戶(2480248971) 10元;
b. 分給合作用戶(of8YZ6LPmjDmYAqdobIvwTdQQjR8) 10元;
c. 設(shè)置unfreeze_unsplit為false(不解凍剩余金額,表示后續(xù)還需執(zhí)行分賬動(dòng)作),同時(shí)指定出資方為接收方賬戶,解凍80元回出資方賬戶參與當(dāng)日軋差結(jié)算。
{
"appid": "wx7bc98d929da735fe",
"out_order_no": "MCH1349FG041421146",
"receivers": [
{
"account": "2480248971",
"amount": 1000,
"currency": "CNY",
"description": "子單一:分給xxx商戶",
"type": "MERCHANT_ID"
},
{
"account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
"amount": 1000,
"currency": "CNY",
"description": "子單一:分給xxx用戶",
"type": "PERSONAL_OPENID"
},
{
"account": "999952224", # 注:這里填出資方商戶號(hào)
"amount": 8000,
"currency": "CNY",
"description": "子單一:解凍出境",
"type": "MERCHANT_ID"
}
],
"sub_mchid": "999968479",
"transaction_id": "4200000028202203236604547485",
"unfreeze_unsplit": false
}
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
二級(jí)商戶號(hào) | sub_mchid | string[1, 32] | 否 | 微信支付分配的商戶號(hào) 示例值:1900000109 |
微信支付訂單號(hào) | transaction_id | string[1, 32] | 是 | 微信支付訂單號(hào) 示例值:4208450740201411110007820472 |
商戶分賬單號(hào) | out_order_no | string[1, 64] | 是 | 商戶分賬單號(hào),同請(qǐng)求入?yún)ⅰ?br/> 示例值:P20150806125346 |
微信分賬單號(hào) | order_id | string[1, 64] | 是 | 微信分賬單號(hào),微信系統(tǒng)返回的唯一標(biāo)識(shí)。 示例值:3008450740201411110007820472 |
分賬單狀態(tài) | state | string | 是 | 分賬單狀態(tài)(每個(gè)接收方的分賬結(jié)果請(qǐng)查看receivers中的result字段)。 PROCESSING:處理中, FINISHED:分賬完成, 示例值:FINISHED |
+ 分賬接收方列表 | receivers | array[1,50] | 是 | 分賬接收方列表 商戶在發(fā)起分賬請(qǐng)求或解凍剩余資金請(qǐng)求時(shí),對(duì)同一筆訂單可分給多個(gè)接收方(包括解凍給出資方),分賬明細(xì)描述了每筆分給一個(gè)接收方的資金的狀態(tài)。 |
{
"order_id": "7100000751202203238026613597498",
"out_order_no": "MCH13SFDG234155321146",
"receivers": [
{
"account": "999952224", # 注:該賬戶為出資方商戶號(hào)
"amount": 797,
"create_time": "2022-03-23T17:10:13+08:00",
"currency": "CNY",
"description": "Unfreeze the remaining funds to sponsor",
"detail_id": "7200000751202203238026613597602",
"detail_type": "UNFREEZE_TO_SPONSOR",
"rate_value": 83640300,
"result": "PENDING",
"settlement_amount": 952,
"settlement_currency": "HKD",
"type": "MERCHANT_ID"
},
{
"account": "of8YZ6LPmjDmYAqdobIvwTdQQjR8",
"amount": 99,
"create_time": "2022-03-23T17:10:13+08:00",
"currency": "CNY",
"description": "分給xxx用戶-10%",
"detail_id": "7200000751202203238026613597699",
"detail_type": "DISTRIBUTE_TO_OTHERS",
"result": "PENDING",
"type": "PERSONAL_OPENID"
},
{
"account": "2480248971",
"amount": 99,
"create_time": "2022-03-23T17:10:13+08:00",
"currency": "CNY",
"description": "分給xxx商戶-10%",
"detail_id": "7200000751202203238026613597767",
"detail_type": "DISTRIBUTE_TO_OTHERS",
"result": "PENDING",
"type": "MERCHANT_ID"
}
],
"state": "PROCESSING",
"sub_mchid": "999968479",
"transaction_id": "4200000012202203235765130087"
}
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 用戶類型為PERSONAL_OPENID,參數(shù)appid未設(shè)置 | 用戶類型為PERSONAL_OPENID,請(qǐng)?jiān)O(shè)置appid字段 |
400 | INVALID_REQUEST | 用戶類型為PERSONAL_SUB_OPENID,參數(shù)sub_appid未設(shè)置 | 用戶類型為PERSONAL_SUB_OPENID,請(qǐng)?jiān)O(shè)置sub_appid字段 |
400 | INVALID_REQUEST | 用戶OpenID和傳入的AppID不匹配 | 請(qǐng)校驗(yàn)OpenID是在哪個(gè)商戶的授權(quán)場(chǎng)景下所獲取,并參照API文檔中的分賬接收方類型字段說(shuō)明,設(shè)置相應(yīng)AppID字段 |
400 | INVALID_REQUEST | 請(qǐng)求分賬時(shí),分賬接收方列表中有重復(fù)賬戶 | 請(qǐng)檢查分賬接收方列表,去除同一次分賬請(qǐng)求中的重復(fù)賬戶后再執(zhí)行請(qǐng)求 |
400 | INVALID_REQUEST | 個(gè)人接收方選擇傳入姓名字段但未確認(rèn)用戶授權(quán)狀態(tài) | 若選擇傳入個(gè)人接收方姓名以執(zhí)行用戶實(shí)名信息一致性校驗(yàn),需要商戶先獲取用戶授權(quán),并設(shè)置authorized字段為true |
400 | INVALID_REQUEST | 請(qǐng)求分賬時(shí),個(gè)人接收方在微信側(cè)的實(shí)名信息與傳入的姓名字段值不一致 | 請(qǐng)和接收方用戶確認(rèn)實(shí)名信息無(wú)誤后,再執(zhí)行請(qǐng)求 |
400 | INVALID_REQUEST | 目前分賬幣種只支持CNY | 請(qǐng)檢查分賬接收方列表,將分賬幣種調(diào)整為CNY之后再執(zhí)行請(qǐng)求 |
400 | INVALID_REQUEST | 該訂單已經(jīng)超過最大可分賬時(shí)間期限 | 請(qǐng)重新檢查訂單支付時(shí)間, 超過最大可分賬時(shí)間期限的訂單不允許再發(fā)起分賬(已經(jīng)由系統(tǒng)發(fā)起解凍購(gòu)匯出境) |
400 | INVALID_REQUEST | 該訂單不支持分賬 | 請(qǐng)檢查微信支付訂單號(hào)是否填錯(cuò),并確認(rèn)在調(diào)用下單API之前執(zhí)行調(diào)用分賬標(biāo)記API成功 |
400 | INVALID_REQUEST | 請(qǐng)求的商戶信息與原支付訂單商戶信息不一致 | 請(qǐng)仔細(xì)檢查訂單號(hào)是否填錯(cuò)、二級(jí)子商戶是否未填或填錯(cuò) |
400 | INVALID_REQUEST | 若選擇解凍剩余未分金額(即在分賬請(qǐng)求中設(shè)置unfreeze_unsplit為true),不能添加出資方為接收方 | 若選擇解凍剩余金額(即在分賬請(qǐng)求中設(shè)置unfreeze_unsplit為true),請(qǐng)移除分賬接收方列表中的出資方賬戶后再執(zhí)行請(qǐng)求 |
400 | INVALID_REQUEST | 若選擇部分解凍時(shí),解凍資金對(duì)應(yīng)的賬戶填寫錯(cuò)誤(應(yīng)設(shè)置為實(shí)際出資方) | 請(qǐng)將出資方設(shè)置為真正出賬的微信賬戶,機(jī)構(gòu)商請(qǐng)?zhí)顚憴C(jī)構(gòu)商戶號(hào),服務(wù)商請(qǐng)?zhí)顚懽由虘籼?hào) |
400 | INVALID_REQUEST | 請(qǐng)求分賬時(shí)校驗(yàn)到分賬接收關(guān)系不存在,請(qǐng)檢查所有接收方是否已添加 | 請(qǐng)檢查所有接收方是否已添加 |
400 | INVALID_REQUEST | 請(qǐng)求分賬時(shí)校驗(yàn)到分賬接收關(guān)系未生效或已解除,請(qǐng)檢查所有接收方狀態(tài)是否為生效中 | 請(qǐng)檢查所有接收方狀態(tài)是否為生效中 |
400 | INVALID_REQUEST | 傳入的AppID與發(fā)起商戶的綁定關(guān)系不存在 | 請(qǐng)確認(rèn)appid字段和發(fā)起方商戶是否綁定成功 |
400 | INVALID_REQUEST | 傳入的SubAppID與對(duì)應(yīng)二級(jí)商戶的綁定關(guān)系不存在 | 請(qǐng)確認(rèn)sub_appid字段和二級(jí)商戶是否綁定成功,機(jī)構(gòu)商可在商戶平臺(tái)>Institution>Application>對(duì)應(yīng)二級(jí)商戶的Development configuration上查看該二級(jí)商戶綁定的sub_appid |
403 | USER_ERROR | 接收方列表中存在某接收方用戶未實(shí)名認(rèn)證,其微信零錢賬戶無(wú)法接受入金請(qǐng)求 | 請(qǐng)檢查分賬接收方列表,確認(rèn)接收方用戶均已通過微信實(shí)名認(rèn)證后再發(fā)起請(qǐng)求 |
403 | USER_ERROR | 接收方列表中存在某接收方用戶賬戶被限制收款,其零錢賬戶累計(jì)收款額度+本次收款金額已超過限制 | 若出現(xiàn)用戶入賬限額場(chǎng)景,被限額的用戶會(huì)收到微信推送消息,請(qǐng)引導(dǎo)接收方用戶根據(jù)指引完成升級(jí)后再發(fā)起分賬 |
403 | USER_ERROR | 接收方列表中存在某接收方用戶賬戶命中微信側(cè)風(fēng)險(xiǎn)攔截策略,其零錢賬戶被限制收款 | 被平臺(tái)側(cè)提示風(fēng)險(xiǎn)攔截的用戶,被全場(chǎng)景限制收款,請(qǐng)?zhí)蕹鄳?yīng)風(fēng)險(xiǎn)接收方后再發(fā)起分賬請(qǐng)求 |
403 | NO_AUTH | 商戶未簽約境外分賬產(chǎn)品能力 | 請(qǐng)參考產(chǎn)品流程和接入準(zhǔn)備,確認(rèn)商戶具有分賬權(quán)限后再發(fā)起請(qǐng)求 |
403 | NO_AUTH | 商戶已開通分賬產(chǎn)品能力,等待生效中(一般為第二天才生效) | 開通分賬產(chǎn)品能力當(dāng)天不能發(fā)起分賬,請(qǐng)等待第二天后發(fā)起請(qǐng)求 |
403 | NO_AUTH | 分賬接收方境外權(quán)限被處罰 | 請(qǐng)確認(rèn)分賬接收方均合法合規(guī)后,請(qǐng)發(fā)起分賬請(qǐng)求 |
403 | NO_AUTH | 商戶父子關(guān)系不存在,請(qǐng)使用正確的二級(jí)商戶號(hào)發(fā)起請(qǐng)求 | 請(qǐng)檢查二級(jí)商戶號(hào)(sub_mchid)是否填寫正確 |
400 | INVALID_REQUEST | 商戶請(qǐng)求分賬時(shí)指令(out_order_no)已存在,且接收方與現(xiàn)有分賬指令不一致 | 若為同一分賬請(qǐng)求,請(qǐng)校驗(yàn)接收方信息是否一致;若為不同分賬請(qǐng)求,請(qǐng)更換外部指令單號(hào)(out_order_no)再發(fā)起分賬請(qǐng)求 |
400 | INVALID_REQUEST | 商戶請(qǐng)求分賬時(shí)指令(out_order_no)已存在,且分賬金額與現(xiàn)有指令不一致 | 若為同一分賬請(qǐng)求,請(qǐng)校驗(yàn)接收方列表中的分賬金額是否一致;若為不同分賬請(qǐng)求,請(qǐng)更換外部指令單號(hào)(out_order_no)再發(fā)起分賬請(qǐng)求 |
400 | INVALID_REQUEST | 商戶請(qǐng)求分賬時(shí)指令(out_order_no)已存在,但轉(zhuǎn)賬明細(xì)數(shù)量不一致 | 若為同一分賬請(qǐng)求,請(qǐng)校驗(yàn)接收方列表是否一致;若為不同分賬請(qǐng)求,請(qǐng)更換外部指令單號(hào)(out_order_no)再發(fā)起分賬請(qǐng)求 |
400 | INVALID_REQUEST | 商戶解凍剩余資金時(shí)指令(out_order_no)已存在,且明細(xì)內(nèi)容不符合預(yù)期 | 若為不同分賬請(qǐng)求,請(qǐng)更換外部指令單號(hào)(out_order_no)再發(fā)起分賬請(qǐng)求 |
400 | INVALID_REQUEST | 請(qǐng)求分賬解凍出境時(shí)外幣結(jié)算金額不能為0 | 請(qǐng)適當(dāng)調(diào)整對(duì)應(yīng)的解凍人民幣金額,使得兌換成外幣后的外幣金額大于0 |
400 | INVALID_REQUEST | 請(qǐng)求分賬時(shí)分出金額超過最大比例 | 請(qǐng)調(diào)整分出金額至分出比例上限以內(nèi)后再發(fā)起分賬請(qǐng)求 |
400 | INVALID_REQUEST | 該訂單已經(jīng)超過最大分賬次數(shù)限制,不能再發(fā)起分賬 | 請(qǐng)直接調(diào)用【解凍剩余金額API】執(zhí)行解凍 |
403 | NOTENOUGH | 請(qǐng)求分賬時(shí)校驗(yàn)到可分金額不足 | 可通過【查詢剩余待分金額API】來(lái)獲取訂單當(dāng)前的可分金額 |
500 | SYSYTEMERROR | 商戶發(fā)起分賬請(qǐng)求指定的微信支付訂單資金凍結(jié)流程還未完成,請(qǐng)稍后重試 | 用戶支付完成后即會(huì)觸發(fā)對(duì)該筆分賬支付單的資金凍結(jié)流程,建議商戶可在3~5min后重試 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證