Cancelar Saque Recorrente

Utilize este endpoint para cancelar um saque recorrente ativo. Todos os agendamentos futuros (SCHEDULED) são cancelados; agendamentos já processados não são afetados.

ℹ️ Apenas saques ativos podem ser cancelados

Só é possível cancelar um saque recorrente com status ACTIVE. Tentar cancelar um já CANCELLED resulta em erro.

Ambientes Disponíveis

Produção

https://api.gateway.com.br/core

Endpoint

• Método: PUT
• Endpoint: /recurring-withdrawal/{id}/cancel
• Autenticação: Bearer token

Path Params

Nome	Tipo	Obrigatório	Descrição	Validações
id	string (UUID)	Sim	Identificador do saque recorrente	Deve ser UUID válido

Exemplo de Requisição

cURL

curl --request PUT \
--url https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel \
--header 'Authorization: Bearer seu-token-jwt'

JavaScript

const response = await fetch('https://api.gateway.com.br/core/recurring-withdrawal/553e8400-e29b-41d4-a716-436251480000/cancel', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer seu-token-jwt'
  }
});

Resposta de Sucesso

Código	Descrição
200 OK	Saque recorrente cancelado com sucesso

ℹ️ Corpo da resposta

Este endpoint não possui payload de resposta.

Possíveis Erros

Código	Descrição	Solução
401	Credenciais inválidas	Verifique suas credenciais
403	Sem permissão/autorização	Contate o suporte
404	Registro não encontrado	Verifique o id informado
422	Saque recorrente já cancelado	Apenas saques recorrentes com status ACTIVE podem ser cancelados
500	Erro interno	Contate o suporte