申请资金出境退回

更新时间:2025.02.24

商户可通过该接口发起资金出境退回申请,用于上报已跨境订单的退款信息。默认接口限频150/s

接口说明

支持商户:【平台商户】

请求方式:【POST】/v3/funds-to-oversea/return/return-orders

请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

     【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看

请求参数

Header HTTP头参数

Authorization  必填 string

请参考签名认证生成认证信息


Accept  必填 string

请设置为application/json


Content-Type  必填 string

请设置为application/json


body 包体参数

out_return_no  必填 string(64)

【商户出境退回单号】 只能由数字,大小写字母_-组成。 由商户在发起资金出境退回请求时生成,要求在同一个商户号下唯一


sub_mchid  必填 string(64)

【二级商户号】 申请资金出境退回的二级商户号


out_order_id  必填 string(64)

【商户出境单号】 商户出境单号,仅支持已跨境成功的支付单据申报退回,微信支付会根据出境单号匹配历史出境单据和支付单信息


transaction_id  必填 string(64)

【微信订单号】 发生跨境转账退回的境内微信支付订单单号


refund_id  必填 string(64)

【微信退款单号】 微信退款单号,申请出境资金退回时需要对应的境内退款单信息作为凭证


amount  必填 integer

【退回金额】 申请资金出境退回的金额,单位:分

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/funds-to-oversea/return/return-orders \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "out_return_no" : "R20250220103930",
8    "sub_mchid" : "1900000109",
9    "out_order_id" : "merchant_1123123",
10    "transaction_id" : "420000000000000010",
11    "refund_id" : "5017752501201407033233368018",
12    "amount" : 100
13  }'
14

应答参数

200 OK

out_return_no  必填 string(64)

【商户出境退回单号】 只能由数字,大小写字母_-组成。 由商户在发起资金出境退回请求时生成,要求在同一个商户号下唯一


sub_mchid  必填 string(64)

【二级商户号】 申请资金出境退回的二级商户号


return_id  必填 string(64)

【微信出境退回单号】 微信出境退回单号


out_order_id  必填 string(64)

【商户出境单号】 商户出境单号,仅支持已跨境成功的支付单据申报退回


transaction_id  必填 string(64)

【微信订单号】 微信支付订单号


refund_id  必填 string(64)

【微信退款单号】 微信退款单号


amount  必填 integer

【退回金额】 申请资金出境退回的金额,单位:分


state  必填 string

【状态】 出境退回状态

可选取值

  • PROCESSING: 出境退回处理中

  • SUCCESS: 资金已退回

  • FAILED: 可退回金额不足时,超过一定时间,业务可能自动关闭申请


create_time  必填 string(64)

【创建时间】 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2025-02-20T10:29:35+08:00表示,北京时间2025年2月20日 10点29分35秒。


success_time  选填 string(64)

【成功时间】 当result为SUCCESS时有这个字段。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2025-02-20T10:29:35+08:00表示,北京时间2025年2月20日 10点29分35秒。


fail_reason  选填 string

【失败原因】 当state为FAILED时,会出现此字段,标明出境退回失败的原因

可选取值

  • RETURN_AMOUNT_NOT_ENOUGH: 可退回金额不足

应答示例

200 OK

1{
2  "out_return_no" : "R20250220103930",
3  "sub_mchid" : "1900000109",
4  "return_id" : "2375897293812",
5  "out_order_id" : "merchant_1123123",
6  "transaction_id" : "420000000000000010",
7  "refund_id" : "5017752501201407033233368018",
8  "amount" : 100,
9  "state" : "PROCESSING",
10  "create_time" : "2025-02-20T10:29:35+08:00",
11  "success_time" : "2025-02-22T10:29:35+08:00",
12  "fail_reason" : "RETURN_AMOUNT_NOT_ENOUGH"
13}
14

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

403

NO_AUTH

商户无权限申请资金出境退回

商户无权限申请资金出境退回,请申请相关权限

429

FREQUENCY_LIMITED

频率限制

请降低频率后重试

 

 

反馈
咨询
目录
置顶