Skip to main content
POST
Cancel a Transfer

Autorizações

Authorization
string
header
obrigatório

JWT Bearer token authentication. The tenantId is derived from the bearer token or authenticated request context and is not supplied through X-Organization-Id.

Cabeçalhos

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

Midaz organization scope for the request, used for downstream CRM, Fees, and Midaz calls. Required on org-scoped transfer routes in every deployment mode; a missing or non-UUID value returns 400. This is not the tenant identifier — tenantId is derived from the bearer JWT or authenticated context, never from this header. Background workers (TED IN poller, reconciliation) have no request header and, in single-tenant mode, fall back to the deployment's ORGANIZATION_ID env.

X-Idempotency
string
obrigatório

Required idempotency key for safe retries. Use a UUID v4 or unique business identifier. If the same key is sent again and the original request was already processed, the cached response is returned.

See Retries and idempotency for details.

Maximum string length: 255

Parâmetros de caminho

transferId
string<uuid>
obrigatório

The unique identifier of the transfer to cancel.

Resposta

Indicates that the transfer was successfully cancelled and funds were released.

Repeated calls with the same X-Idempotency key replay the cached response.

See Retries and idempotency for more details.

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"