最新更新时间:2023.08.09 版本说明
商户发起资金出境请求,需要传微信支付单号,商户出境单号,出境金额等信息 成功,接口请求成功仅代表受理,如需知晓业务执行情况请通过查询接口获取。
适用对象:电商平台
请求URL:https://api.mch.weixin.qq.com/v3/funds-to-oversea/orders
请求方式:POST
接口频限:150QPS
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户出境单号 | out_order_id | string[1, 64] | 是 | body订单的主键,唯一定义此资源的标识,此参数只能由数字,大小写字母_-组成。 由商户在发起资金出境请求时生成,要求在同一个商户号下唯一。 示例值:merchant_1123123 |
二级商户号 | sub_mchid | string[1, 64] | 是 | body申请资金出境的二级商户号 示例值:123456 |
微信订单号 | transaction_id | string[1, 128] | 是 | body微信支付返回的支付订单号 示例值:420000000000000010 |
出境金额 | amount | int | 是 | body需要出境的人民币金额,单位:分 示例值:10 |
境外收款币种 | foreign_currency | string[1, 20] | 是 | body境外收款币种。 注:微信支付分配的收款人识别号属性下所关联的币种,会校验该币种字段与收款人识别号的相关性。 示例值:USD |
+ 商品信息 | goods_info | array | 否 | body必填字段,goods_info数量不能超过10个 |
+ 卖家信息 | seller_info | object | 是 | body卖家信息 |
+ 物流信息 | express_info | object | 否 | body物流信息 注意:仅在预售场景且定金订单需单独出境时,该字段可不填;其他场景下,该字段必填 |
+ 预售信息 | presale_info | object | 否 | body 预售信息 注意:定金与尾款对应的订单均需在三年(1096天)内,且定金支付人与尾款支付人需一致 |
+ 收款人信息 | payee_info | object | 是 | body收款人信息 |
{
"amount": 10,
"express_info": {
"courier_number": "curier_number_1231",
"express_company_name": "国际xxx物流"
},
"foreign_currency": "USD",
"goods_info": [
{
"goods_category": "家用电器",
"goods_name": "橘子",
"goods_quantity": 1,
"goods_unit_price": 1
}
],
"out_order_id": "merchant_1123123",
"payee_info": {
"payee_id": "ID123112312"
},
"seller_info": {
"oversea_business_name": "香港xxxx公司",
"oversea_shop_name": "香港xxx公司xxx店铺",
"seller_id": "id2123123123"
},
"presale_info": {
"type": "DEPOSIT",
"deposit_transaction_id": "208450740201411110007820472",
"balance_transaction_id": "4208450740201411110007820472",
"total_amount": 10
},
"payee_id": {
"courier_number": "ID123112312"
},
"sub_mchid": "123456",
"transaction_id": "420000000000000010"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
商户出境单号 | out_order_id | string[1, 64] | 是 | 订单的主键,唯一定义此资源的标识,此参数只能由数字,大小写字母_-组成。 由商户在发起资金出境请求时生成,要求在同一个商户号下唯一。 示例值:merchant123123 |
二级商户号 | sub_mchid | string[1, 64] | 是 | 申请资金出境的二级商户号 示例值:1231231 |
微信出境单号 | order_id | string[1, 128] | 是 | 微信出境单号 示例值:42000000000_123123 |
出境结果 | result | string[1, 128] | 是 | 出境的结果,
枚举值: ACCEPT:已受理 SUCCESS:出境成功 FAIL:出境失败 示例值:ACCEPT |
出境失败的原因 | fail_reason | string[1, 128] | 否 | 当result为FAIL时,会出现此字段,标明出境失败原因,如果是SYSTEM_ERROR可以重新发起重试 失败原因: MCHID_FROZEN:商户已冻结,转账失败 DEAL_TIMEOUT:单据已过期 TRADE_SUIT:交易订单被交易投诉冻结 DEPARTURE_AMOUNT_NO_ENOUGH:剩余可出境金额不足 BASIC_AMOUNT_NO_ENOUGH:商户基本户余额不足 PAYMENT_NOT_SUPPORT_DEPARTURE:该笔订单不支持出境 OUT_ORDER_ID_DUPLICATE:同一个out_order_id用于不同的支付订单 RISK_CONTROL:订单被风控拦截 SYSTEM_ERROR:系统失败 FEE_ACCOUNT_NOT_OPEN:电商平台承担手续费但是未开通手续费账户或者手续费账户被处罚 PAYER_ACCOUNT_ABNORMAL:资金出境方账户异常 GOODS_INFO_ILLEGAL: 资金出境申请商品信息非法 FOREIGN_CURRENCY_NOT_SUPPORT: 不支持的币种类型,请换币种重试,目前仅支持八大币种:USD、HKD、JPY、EUR、GBP、CAD、AUD、SGD PAYEE_INFO_ILLEGAL:校验收款人信息失败 PRESALE_INFO_ILLEGAL:资金出境申请预售信息非法 示例值:DEPARTURE_AMOUNT_NO_ENOUGH |
请求出境人民币金额 | amount | int | 是 | 需要出境的人民币金额,单位:分 示例值:21 |
真实出境外币金额 | foreign_amount | int | 否 | 真实出境的外币金额,单位:该币种最小计价单位,当result为SUCCESS时有这个字段 示例值:20 |
外币币种 | foreign_currency | string[1, 20] | 是 | 出境的目标币种,由商户在资金出境申请接口传入。 示例值:USD |
汇率 | rate | int | 否 | 当result为SUCCESS时有这个字段,标价币种与支付币种的兑换比例乘以10的8次方即为此值,例如美元兑换人民币的比例为6.5,则rate=650000000 示例值:650000000 |
购汇时间 | exchange_rate_time | string[1, 64] | 否 | 当result为SUCCESS时有这个字段。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
预计购汇时间 | estimate_exchange_rate_time | string[1, 64] | 否 | 当result为ACCEPT时可能有这个字段,以实际结果为准。 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
真实出境人民币金额 | departure_amount | int | 否 | 真正出境的人民币金额,单位:分,如果是二级商户承担手续费且非收支分离,该金额=请求出境金额-手续费,否则该金额=请求出境金额 示例值:20 |
手续费人民币金额 | fee | int | 否 | 资金出境手续费人民币金额,单位:分 示例值:1 |
手续费承担商户号 | charge_mchid | string[1,64] | 否 | 手续费承担商户号 示例值:1231231 |
手续费承担账户 | charge_account_type | string | 否 | 基本账户或者手续费账户 BASIC:基本账户 FEES:手续费账户 示例值:BASIC |
{
"amount": 21,
"charge_account_type": "BASIC",
"charge_mchid": "1231231",
"departure_amount": 20,
"estimate_exchange_rate_time": "2015-05-20T13:29:35+08:00",
"exchange_rate_time": "2015-05-20T13:29:35+08:00",
"fail_reason": "DEPARTURE_AMOUNT_NO_ENOUGH",
"fee": 1,
"foreign_amount": 20,
"foreign_currency": "USD",
"order_id": "42000000000_123123",
"out_order_id": "merchant123123",
"rate": 650000000,
"result": "ACCEPT",
"sub_mchid": "1231231"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | NO_AUTH | 商户无权限申请资金出境 | 商户无权限申请资金出境,请申请相关权限 |
400 | PARAM_ERROR | 参数错误 | 请求参数错误,请重新检查再调用查询剩余可出境余额 |
429 | FREQUENCY_LIMITED | 请求频率过高 | 请求频率超过限制,请稍后重试;同一笔订单2秒内只能请求一次出境 注:服务商模式下是针对该接口频限是,整个服务商维度的限制 |