Cancelar uma Transferência
Use este endpoint para cancelar uma transferência que ainda não foi enviada para processamento. Apenas transferências com status CREATED ou PENDING podem ser canceladas. Cancelar uma transferência libera os fundos retidos no Midaz e define o status como CANCELLED. Chamar cancel em uma transferência já cancelada retorna sucesso.
Este endpoint não recebe corpo de requisição — a transferência é identificada apenas pelo parâmetro de caminho.
Autorizações
Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id.
Cabeçalhos
Escopo da organização Midaz para a requisição, usado para chamadas downstream ao CRM, Fees e Midaz. Obrigatório nas rotas de transferência com escopo de organização em todos os modos de implantação; um valor ausente ou que não seja UUID retorna 400. Este não é o identificador do tenant — o tenantId é derivado do JWT bearer ou do contexto autenticado, nunca deste cabeçalho. Workers em segundo plano (poller de TED IN, conciliação) não possuem cabeçalho de requisição e, no modo single-tenant, recorrem à variável de ambiente ORGANIZATION_ID da implantação.
Chave de idempotência obrigatória para tentativas seguras. Use um UUID v4 ou identificador de negócio único. Se a mesma chave for enviada novamente e a solicitação original já tiver sido processada, a resposta em cache será retornada.
Consulte Tentativas e idempotência para detalhes.
255Parâmetros de caminho
O identificador único da transferência a ser cancelada.
Resposta
Indica que a transferência foi cancelada com sucesso e os fundos foram liberados.
Chamadas repetidas com a mesma chave X-Idempotency reproduzem a resposta em cache.
Consulte Tentativas e idempotência para mais detalhes.

