查询出境退回结果(通过商户出境退回单号)
更新时间:2025.02.24通过商户出境退回单号查询出境退回处理结果。默认接口限频300/s
接口说明
支持商户:【平台商户】
请求方式:【GET】/v3/funds-to-oversea/return/return-orders/out-return-no/{out_return_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
out_return_no 必填 string(64)
【商户出境退回单号】 商户在发起资金出境退回请求时生成,要求在同一个商户号下唯一。只能由数字,大小写字母_-组成
query 查询参数
sub_mchid 必填 string(64)
【二级商户号】 申请资金出境退回的二级商户号
请求示例
GET
应答参数
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
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
404 | NOT_FOUND | 资金出境退回单不存在 | 请检查二级商户号、商户出境退回单号是否正确 |
429 | FREQUENCY_LIMITED | 频率限制 | 请降低频率后重试 |