查詢分賬接收方添加結(jié)果API
最新更新時(shí)間：2022.08.04 版本說(shuō)明
商戶發(fā)起添加分賬接收方請(qǐng)求后，可通過(guò)調(diào)用本API來(lái)查詢分賬接收方添加結(jié)果。只有當(dāng)微信審核接收方材料通過(guò)，接收方關(guān)系狀態(tài)扭轉(zhuǎn)為EFFECTIVE后，才允許調(diào)用請(qǐng)求分賬API接口來(lái)分給該接收方。
1. 接口說(shuō)明
適用對(duì)象：直連模式 機(jī)構(gòu)模式
請(qǐng)求URL：https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers/{account}
請(qǐng)求方式：GET
Path指該參數(shù)為路徑參數(shù)
Query指該參數(shù)為URL參數(shù)
Body指該參數(shù)需在請(qǐng)求JSON傳參
2. 請(qǐng)求參數(shù)
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 二級(jí)商戶號(hào) | sub_mchid | string[1, 32] | 否 | Query微信支付分配的商戶號(hào)，請(qǐng)與微信支付訂單的二級(jí)商戶號(hào)保持一致。（直連商戶不需要，服務(wù)商/機(jī)構(gòu)模式下必填） 示例值：1900000109 |
| 公眾賬號(hào)ID | appid | string[1, 32] | 否 | Query微信分配的商戶公眾賬號(hào)ID，分賬接收方類型包含PERSONAL_OPENID時(shí)必填。 示例值：wx8888888888888888 |
| 二級(jí)商戶公眾賬號(hào)ID | sub_appid | string[1, 32] | 否 | Query微信分配的二級(jí)商戶公眾賬號(hào)ID，分賬接收方類型包含PERSONAL_SUB_OPENID時(shí)必填。 示例值：wx8888888888888889 |
| 接收方類型 | type | string | 是 | Query接收方類型 MERCHANT_ID - 商戶號(hào)， PERSONAL_OPENID - 個(gè)人OpenID，由商戶APPID轉(zhuǎn)換得到 PERSONAL_SUB_OPENID - 是個(gè)人Sub_OpenID，由二級(jí)商戶APPID轉(zhuǎn)換得到 示例值：MERCHANT_ID |
| 接收方賬號(hào) | account | string[1, 64] | 是 | Path類型是MERCHANT_ID時(shí)，是商戶號(hào) 類型是PERSONAL_OPENID時(shí)，是個(gè)人OpenID 類型是PERSONAL_SUB_OPENID時(shí)，是個(gè)人Sub_OpenID 示例值：86693852 |
請(qǐng)求示例
https://apihk.mch.weixin.qq.com/v3/global/profit-sharing/receivers/of8YZ6LPmjDmYAqdobIvwTdQQjR8?appid=wx8888888888888888&type=PERSONAL_OPENID
3. 返回參數(shù)
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 二級(jí)商戶號(hào) | sub_mchid | string[1, 32] | 否 | 二級(jí)商戶號(hào)，同請(qǐng)求入?yún)ⅰ?br/> 示例值：1900000109 |
| 接收方類型 | type | string | 是 | 接收方類型，同請(qǐng)求入?yún)ⅰ? MERCHANT_ID - 商戶號(hào)， PERSONAL_OPENID - 個(gè)人OpenID，由商戶APPID轉(zhuǎn)換得到 PERSONAL_SUB_OPENID - 是個(gè)人Sub_OpenID，由二級(jí)商戶APPID轉(zhuǎn)換得到 示例值：MERCHANT_ID |
| 接收方賬號(hào) | account | string[1, 64] | 是 | 接收方賬號(hào)，同請(qǐng)求入?yún)ⅰ?br/> 示例值：86693852 |
| 分賬接收方全稱 | name | string[1, 1024] | 否 | 分賬接收方全稱，同請(qǐng)求入?yún)ⅰ?br/> 示例值：hu89ohu89ohu89o |
| 與分賬方的關(guān)系類型 | relation_type | string | 是 | 與分賬方的關(guān)系類型，同請(qǐng)求入?yún)ⅰ? SUPPLIER - 供應(yīng)商， DISTRIBUTOR - 分銷商， TAX_SERVICE_PROVIDER - 稅費(fèi)服務(wù)商， IT_SERVICE_PROVIDER - 技術(shù)服務(wù)提供方， CUSTOM - 自定義， 示例值：SUPPLIER |
| 自定義的分賬關(guān)系 | custom_relation | string[1, 10] | 否 | 自定義的分賬關(guān)系，同請(qǐng)求入?yún)ⅰ?br/> 示例值：代理商 |
| 分賬場(chǎng)景詳細(xì)描述 | scene | string[3, 256] | 是 | 分賬場(chǎng)景詳細(xì)描述，同請(qǐng)求入?yún)ⅰ?br/> 示例值：該分賬接收方是境內(nèi)稅費(fèi)服務(wù)提供方，幫助商戶向境內(nèi)海關(guān)代扣代繳稅費(fèi)。 |
| 接收方商戶的主營(yíng)業(yè)務(wù)范圍 | major_service | string[3, 256] | 否 | 接收方商戶的主營(yíng)業(yè)務(wù)范圍，同請(qǐng)求入?yún)ⅰ?br/> 示例值：稅務(wù)準(zhǔn)備服務(wù) |
| 分賬接收方預(yù)計(jì)分賬比例 | expected_ratio | int | 是 | 分賬接收方預(yù)計(jì)分賬比例，同請(qǐng)求入?yún)ⅰ?br/> 示例值：2000 |
| 接收方關(guān)系狀態(tài) | state | string | 是 | 分賬方與該接收方的關(guān)系狀態(tài)，僅允許對(duì)EFFECTIVE的接收方發(fā)起分賬。 INIT - 待審核，等待微信審核接收方資料 EFFECTIVE - 生效中，接收方關(guān)系生效中 AUDIT_FAILED - 審核未通過(guò)，接收方審核未通過(guò) 示例值：AUDIT_FAILED |
| 接收關(guān)系添加失敗原因 | fail_reason | string | 否 | 添加分賬接收方失敗的原因，只有在state為AUDIT_FAILED時(shí)才會(huì)出現(xiàn) PARTNERSHIP_NOT_SUPPORTED - 合作關(guān)系不支持，分賬接收方合作關(guān)系不支持分賬 DEFAULT_ERROR - 默認(rèn)錯(cuò)誤， 示例值：PARTNERSHIP_NOT_SUPPORTED |
返回示例
{
"account":"of8YZ6LPmjDmYAqdobIvwTdQQjR8",
"custom_relation":"特約主播",
"expected_ratio":800,
"relation_type":"CUSTOM",
"scene":"該分賬接收方為特約帶貨主播",
"state":"INIT",
"type":"PERSONAL_OPENID"
}
4. 錯(cuò)誤碼
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 404 | NOT_FOUND | 分賬關(guān)系不存在 | 請(qǐng)檢查所傳賬戶、接受方類型等字段是否填寫正確 |
| 403 | NO_AUTH | 商戶未簽約境外分賬產(chǎn)品能力 | 請(qǐng)參考產(chǎn)品流程和接入準(zhǔn)備，確認(rèn)商戶具有分賬權(quán)限后再發(fā)起請(qǐng)求 |
| 403 | NO_AUTH | 商戶已開(kāi)通分賬產(chǎn)品能力，等待生效中(一般為第二天才生效) | 開(kāi)通分賬產(chǎn)品能力當(dāng)天不能發(fā)起分賬，請(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)是否填寫正確 |
頁(yè)面導(dǎo)航
