# 查询提现状态

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

接口英文名：queryWithdraw

查询提现状态

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/retail/B2b/querywithdraw?access_token=ACCESS_TOKEN

# 云调用

本接口不支持云调用。

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：158
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String Parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	示例	说明
mchid	string	是	1230000109	微信商户号。长度限制[1,32]。由微信支付生成并下发的商户号。提现金额，示例值：是商户外部提现单号，同一个商户号下唯一，只允许数字和大小写字母_-*，长度要求为[6,32]。示例值：aaa123
out_withdraw_no	string	是	aaa123	外部提现单号。长度限制[6,32]。商户发起提现时传入的外部提现单号。

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明	枚举
out_withdraw_no	string	aaa123	外部提现单号。长度限制[6,32]。商户发起提现时传入的外部提现单号。	-
withdraw_amount	number	100	提现金额	-
status	string	WITHDRAW_SUCC	提现状态	枚举值
fail_reason	string	申请提现金额小于留存额	提现失败原因（仅当提现状态为 WITHDRAW_FAIL 时返回）	-
errcode	number	0	错误码	-
errmsg	string	ok	错误信息	-

# 4. 枚举信息

# Res.status `Enum`

提现状态

枚举值	描述
WITHDRAW_INIT	初始化
WITHDRAW_PROCESSING	进行中
WITHDRAW_SUCC	成功
WITHDRAW_FAIL	失败
WITHDRAW_REFUND	提现退票（银行回退）

# 5. 注意事项

# 6. 代码示例

请求示例

{
    "mchid": "1230000109",
    "out_withdraw_no": "aaa123"
}

返回示例

{
    "out_withdraw_no": "aaa123",
    "withdraw_amount": 100,
    "status": "WITHDRAW_SUCC",
    "errcode": 0,
    "errmsg": "OK"
}

# 7. 错误码

此接口没有特殊错误码，可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

# 8. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。

# 查询提现状态

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String Parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# 4. 枚举信息

# Res.status Enum

# 5. 注意事项

# 6. 代码示例

# 7. 错误码

# 8. 适用范围

# 查询参数 `Query String Parameters`

# 请求体 `Request Payload`

# 返回体 `Response Payload`

# Res.status `Enum`