取消定期提现
使用此端点取消处于生效状态的定期提现。所有未来的排期（SCHEDULED）都会被取消；已处理的排期不受影响。
ℹ️ 只有生效中的提现可以取消
只有状态为 ACTIVE 的定期提现才能取消。对已经是 CANCELLED 的记录再次取消会返回错误。
可用环境
- 生产环境
https://api.gateway.com.br/core
端点
- 方法：
PUT - 端点：
/recurring-withdrawal/{id}/cancel - 认证方式：Bearer token
路径参数
| 名称 | 类型 | 必填 | 说明 | 校验规则 |
|---|---|---|---|---|
id | string (UUID) | 是 | 定期提现的标识 | 必须为有效的 UUID |
请求示例
- cURL
- JavaScript
curl --request PUT \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel \
--header 'Authorization: Bearer your-jwt-token'
const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel', {
method: 'PUT',
headers: {
'Authorization': 'Bearer your-jwt-token'
}
});
成功响应
| 状态码 | 说明 |
|---|---|
200 OK | 定期提现已成功取消 |
ℹ️ 响应体
此端点没有响应体。
可能的错误
| 状态码 | 说明 | 处理方式 |
|---|---|---|
| 401 | 凭据无效 | 请检查您的凭据 |
| 403 | 无权限或未授权 | 请联系技术支持 |
| 404 | 未找到记录 | 请检查传入的 id |
| 422 | 定期提现已取消 | 只有状态为 ACTIVE 的定期提现才能取消 |
| 500 | 内部错误 | 请联系技术支持 |