Pular para o conteúdo principal
POST
Cancelar uma Transferência

Autorizações

Authorization
string
header
obrigatório

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

X-Organization-Id
string<uuid>
obrigatório

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.

X-Idempotency
string
obrigatório

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.

Maximum string length: 255

Parâmetros de caminho

transferId
string<uuid>
obrigatório

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.

transferId
string<uuid>
obrigatório
Exemplo:

"019c96a0-ab10-7cde-f1a2-0e1f2a3b4c5d"

status
enum<string>
obrigatório
Opções disponíveis:
CANCELLED
Exemplo:

"CANCELLED"

cancelledAt
string<date-time>
obrigatório
Exemplo:

"2026-02-01T15:35:00-03:00"