商戶發(fā)起資金出境請求,需要傳微信支付單號,商戶出境單號,出境金額等信息 接口請求成功僅代表受理成功,如需知曉業(yè)務(wù)執(zhí)行情況請通過查詢接口獲取。
# 接口說明
支持商戶:
【普通服務(wù)商】
請求方式:
【POST】/v3/funds-to-oversea/orders
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點(diǎn)【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點(diǎn) ,指引點(diǎn)擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請?jiān)O(shè)置為
application/json
- Content-Type 必填 string請?jiān)O(shè)置為
application/json
Header HTTP頭參數(shù)
- out_order_id 必填 string(64)【商戶出境單號】 訂單的主鍵,唯一定義此資源的標(biāo)識,此參數(shù)只能由數(shù)字,大小寫字母_-組成。
由商戶在發(fā)起資金出境請求時(shí)生成,要求在同一個(gè)商戶號下唯一。 - sub_mchid 必填 string(64)【二級商戶號】 申請資金出境的二級商戶號
- transaction_id 必填 string(64)【微信訂單號】 微信支付返回的支付訂單號
- amount 必填 integer【出境金額】 需要出境的人民幣金額,單位:分
- foreign_currency 必填 string(20)【境外收款幣種】 境外收款幣種。
注:微信支付分配的收款人識別號屬性下所關(guān)聯(lián)的幣種,會校驗(yàn)該幣種字段與收款人識別號的相關(guān)性。 - goods_info 選填 array[GoodsInfo]【商品信息】 必填字段,goods_info數(shù)量不能超過10個(gè)
- 屬性
- seller_info 必填 SellerInfo【賣家信息】 賣家信息
- 屬性
- express_info 選填 ExpressInfo【物流信息】 物流信息
注意:僅在預(yù)售場景且定金訂單需單獨(dú)出境時(shí),該字段可不填;其他場景下,該字段必填- 屬性
- payee_info 必填 PayeeInfo【收款人信息】 收款人信息
- 屬性
- presale_info 選填 PresaleInfo【預(yù)售信息】 預(yù)售信息
注意:定金與尾款對應(yīng)的訂單均需在三年(1096天)內(nèi),且定金支付人與尾款支付人需一致- 屬性
Body 包體參數(shù)
請求示例
POST
# 應(yīng)答參數(shù)
- out_order_id 必填 string(64)【商戶出境單號】 訂單的主鍵,唯一定義此資源的標(biāo)識,此參數(shù)只能由數(shù)字,大小寫字母_-組成。
由商戶在發(fā)起資金出境請求時(shí)生成,要求在同一個(gè)商戶號下唯一。 - sub_mchid 必填 string(64)【二級商戶號】 申請資金出境的二級商戶號
- order_id 必填 string(128)【微信出境單號】 微信出境單號
- result 必填 string(128)【出境結(jié)果】 出境的結(jié)果, 枚舉值:
* ACCEPT:已受理
* SUCCESS:出境成功
* FAIL:出境失敗 - fail_reason 選填 string(128)【出境失敗的原因】 當(dāng)result為FAIL時(shí),會出現(xiàn)此字段,標(biāo)明出境失敗原因,如果是SYSTEM_ERROR可以重新發(fā)起重試
失敗原因:
* MCHID_FROZEN:商戶已凍結(jié),轉(zhuǎn)賬失敗
* DEAL_TIMEOUT:單據(jù)已過期
* TRADE_SUIT:交易訂單被交易投訴凍結(jié)
* DEPARTURE_AMOUNT_NO_ENOUGH:剩余可出境金額不足
* BASIC_AMOUNT_NO_ENOUGH:商戶基本戶余額不足
* PAYMENT_NOT_SUPPORT_DEPARTURE:該筆訂單不支持出境
* OUT_ORDER_ID_DUPLICATE:同一個(gè)out_order_id用于不同的支付訂單
* RISK_CONTROL:訂單被風(fēng)控?cái)r截
* SYSTEM_ERROR:系統(tǒng)失敗
* FEE_ACCOUNT_NOT_OPEN:電商平臺承擔(dān)手續(xù)費(fèi)但是未開通手續(xù)費(fèi)賬戶或者手續(xù)費(fèi)賬戶被處罰
* PAYER_ACCOUNT_ABNORMAL:資金出境方賬戶異常
* GOODS_INFO_ILLEGAL: 資金出境申請商品信息非法
* FOREIGN_CURRENCY_NOT_SUPPORT: 不支持的幣種類型,請換幣種重試,目前僅支持八大幣種:USD、HKD、JPY、EUR、GBP、CAD、AUD、SGD
* PAYEE_INFO_ILLEGAL:校驗(yàn)收款人信息失敗
* PRESALE_INFO_ILLEGAL:資金出境申請預(yù)售信息非法
* 示例值:DEPARTURE_AMOUNT_NO_ENOUGH - amount 必填 integer【請求出境人民幣金額】 需要出境的人民幣金額,單位:分
- foreign_amount 選填 integer【真實(shí)出境外幣金額】 真實(shí)出境的外幣金額,單位:該幣種最小計(jì)價(jià)單位,當(dāng)result為SUCCESS時(shí)有這個(gè)字段
- foreign_currency 必填 string(20)【外幣幣種】 出境的目標(biāo)幣種,由商戶在資金出境申請接口傳入。
- rate 選填 integer【匯率】 當(dāng)result為SUCCESS時(shí)有這個(gè)字段,標(biāo)價(jià)幣種與支付幣種的兌換比例乘以10的8次方即為此值,例如美元兌換人民幣的比例為6.5,則rate=650000000
- exchange_rate_time 選填 string(64)【購匯時(shí)間】 當(dāng)result為SUCCESS時(shí)有這個(gè)字段。遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。
- estimate_exchange_rate_time 選填 string(64)【預(yù)計(jì)購匯時(shí)間】 當(dāng)result為ACCEPT時(shí)可能有這個(gè)字段,以實(shí)際結(jié)果為準(zhǔn)。
遵循rfc3339標(biāo)準(zhǔn)格式,格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出現(xiàn)在字符串中,表示time元素的開頭,HH:mm:ss表示時(shí)分秒,TIMEZONE表示時(shí)區(qū)(+08:00表示東八區(qū)時(shí)間,領(lǐng)先UTC 8小時(shí),即北京時(shí)間)。例如:2015-05-20T13:29:35+08:00表示,北京時(shí)間2015年5月20日 13點(diǎn)29分35秒。 - departure_amount 選填 integer【真實(shí)出境人民幣金額】 真正出境的人民幣金額,單位:分,如果是二級商戶承擔(dān)手續(xù)費(fèi)且非收支分離,該金額=請求出境金額-手續(xù)費(fèi),否則該金額=請求出境金額
- fee 選填 integer【手續(xù)費(fèi)人民幣金額】 資金出境手續(xù)費(fèi)人民幣金額,單位:分
- charge_mchid 選填 string(64)【手續(xù)費(fèi)承擔(dān)商戶號】 手續(xù)費(fèi)承擔(dān)商戶號
- charge_account_type 選填 string【手續(xù)費(fèi)承擔(dān)賬戶】 基本賬戶或者手續(xù)費(fèi)賬戶
可選取值:BASIC
: 基本賬戶FEES
: 手續(xù)費(fèi)賬戶
200OK
應(yīng)答示例
200 OK
# 錯(cuò)誤碼
# 公共錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請根據(jù)錯(cuò)誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗(yàn)證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯(cuò)誤碼
狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|---|
403 | NO_AUTH | 商戶無權(quán)限申請資金出境 | 商戶無權(quán)限申請資金出境,請申請相關(guān)權(quán)限 |
404 | NOT_FOUND | 請求的資源不存在 | 預(yù)售訂單號或尾款訂單號不存在,請檢查重試 |
429 | FREQUENCY_LIMITED | 資金出境限頻 | 請求頻率過高,請于1分鐘后重試 |