Cancelar Retiro Recurrente
Utilice este endpoint para cancelar un retiro recurrente activo. Se cancelan todas las programaciones futuras (SCHEDULED); las programaciones ya procesadas no se ven afectadas.
ℹ️ Solo se pueden cancelar los retiros activos
Solo es posible cancelar un retiro recurrente con estado ACTIVE. Intentar cancelar uno que ya está CANCELLED resulta en error.
Entornos Disponibles
- Producción
https://api.gateway.com.br/core
Endpoint
- Método:
PUT - Endpoint:
/recurring-withdrawal/{id}/cancel - Autenticación: Bearer token
Path Params
| Nombre | Tipo | Obligatorio | Descripción | Validaciones |
|---|---|---|---|---|
id | string (UUID) | Sí | Identificador del retiro recurrente | Debe ser un UUID válido |
Ejemplo de Solicitud
- cURL
- JavaScript
curl --request PUT \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel \
--header 'Authorization: Bearer su-token-jwt'
const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel', {
method: 'PUT',
headers: {
'Authorization': 'Bearer su-token-jwt'
}
});
Respuesta Exitosa
| Código | Descripción |
|---|---|
200 OK | Retiro recurrente cancelado con éxito |
ℹ️ Cuerpo de la respuesta
Este endpoint no tiene payload de respuesta.
Errores Posibles
| Código | Descripción | Solución |
|---|---|---|
| 401 | Credenciales inválidas | Verifique sus credenciales |
| 403 | Sin permiso/autorización | Contacte al soporte |
| 404 | Registro no encontrado | Verifique el id enviado |
| 422 | Retiro recurrente ya cancelado | Solo los retiros recurrentes con estado ACTIVE pueden cancelarse |
| 500 | Error interno | Contacte al soporte |