# 微信支付自动提现接口

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

接口英文名：setautoWithdraw

该接口用于为B2b商户号设置微信支付自动提现。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/retail/B2b/setautowithdraw?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]。由微信支付生成并下发的商户号。	-
status	number	否	1	自动提现状态。是否开启自动提现	枚举值
retain_amt	number	否	500000	留存额。账户留存金额，单位为分。每天根据昨日"可提现金额"账户的日终余额减去留存额，发起提现并到账。若发起提现申请时，"可提现金额账户"的当前余额少于昨日日终余额，则提现失败，返回余额不足的错误。	-

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明
errcode	number	0	错误码
errmsg	string	ok	错误信息

# 4. 枚举信息

# Body.status `Enum`

自动提现状态。是否开启自动提现

枚举值	描述
1	开启自动提现功能
2	关闭自动提现功能

# 5. 注意事项

# 自动提现金额计算：

提现金额规则	设置留存额规则
【日终账户余额】前一日的日终可提现账户余额减留存额	设置留存额以防提现后账户余额不足，影响退款业务，请根据业务实际情况进行设置。当系统自动发起提现时，若当前可提现金额<前一日日终可提现金额-留存额，则提现会失败

# 自动提现说明：

开启自动提现功能后，平台会每天自动将“可提现金额账户”内的资金提取至你的结算银行卡：

1、自动提现发起时间：每日 8:30，自动发起提现申请

2、提现规则：提现时，若“可提现金额账户”的当前余额少于昨日日终余额，则提现失败，返回余额不足的错误。否则，提现金额= 日终余额-留存额。

3、附言格式：B2b支付_YYYYMMDD_商户号

# 6. 代码示例

请求示例

{
    "mchid": "1230000109",
    "status": 1,
    "retain_amt": 500000
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 7. 错误码

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

# 8. 适用范围

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