Skip to main content
POST
Resolve Transfer Reconciliation

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.

Corpo

application/json

Operator decision, justification, and evidence reference (required for SETTLED_BY_HAND).

action
enum<string>
obrigatório
Opções disponíveis:
SETTLE,
REVERT,
RE_POST,
SETTLED_BY_HAND
Exemplo:

"SETTLE"

reason
string
obrigatório
Required string length: 10 - 500
Exemplo:

"JD cabine ticket 4471 confirms settlement at 10:42"

evidenceReference
string

Required for SETTLED_BY_HAND.

Maximum string length: 200
Exemplo:

"STR0008 ctrl 202609061042"

Resposta

Indicates that the transfer was resolved. A ledger reference that names nothing is omitted instead of sent as the all-zeroes UUID: compensationTransactionId and previousCompensationTransactionId belong to the inbound actions, and midazTransactionId is absent on an inbound close of a row whose credit transaction was never proven.

transferId
string<uuid>
Exemplo:

"770e8400-e29b-41d4-a716-446655440003"

status
string
Exemplo:

"COMPLETED"

reconciliationStatus
string
Exemplo:

"RESOLVED"

resolvedAt
string<date-time>
Exemplo:

"2026-09-06T12:00:00Z"

midazTransactionId
string<uuid>
Exemplo:

"11111111-2222-3333-4444-555555555555"

compensationTransactionId
string<uuid>
Exemplo:

"66666666-7777-4888-9999-aaaaaaaaaaaa"

previousCompensationTransactionId
string<uuid>
Exemplo:

"33333333-4444-4555-8666-777777777777"