Pular para o conteúdo principal
POST
Process 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 a unique business identifier, made of letters, digits, ., _, and -. 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
Pattern: ^[a-zA-Z0-9._-]+$

Corpo

application/json
initiationId
string<uuid>
obrigatório

The initiation ID returned by the Initiate Transfer endpoint. Expires after 24 hours.

Exemplo:

"019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b"

signingArtifactId
string<uuid>

Identifier of the frozen signing artifact returned by Prepare Transfer Signature.

Exemplo:

"019c96a0-bb10-7def-a1b2-3c4d5e6f7a8b"

payloadHash
string

SHA-256 hash of the canonical payload that was signed.

Exemplo:

"8f0c7f5c1c7b4d9f2f5c7d1a0d4c9a2b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f"

signature
string

Base64-encoded signature for tenants that sign outside the plugin.

Exemplo:

"base64-signature-here"

Resposta

Indicates that the transfer was confirmed and processing has started.

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

See Retries and idempotency for more details.

transferId
string<uuid>
obrigatório

The unique transfer ID. Use this value to track the transfer status.

Exemplo:

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

confirmationNumber
string
obrigatório

A human-readable confirmation number. Format is YYYYMMDD followed by a short hex suffix derived from the transfer ID (e.g. 20260201aa10bc3d4e5f).

Maximum string length: 20
Exemplo:

"20260201001"

status
enum<string>
obrigatório

The current transfer status. For TED_OUT transfers, the status immediately after processing is always PROCESSING.

Opções disponíveis:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
CANCELLED,
RECEIVED
Exemplo:

"COMPLETED"

feeAmount
number<decimal>
obrigatório

The fee amount as calculated during initiation.

Exemplo:

1.5

totalAmount
number<decimal>
obrigatório

The amount debited from the sender's account: the transfer amount plus any fee charged on top.

Exemplo:

1002

packageAppliedId
string<uuid> | null

ID of the fee package applied to this transfer, if any.

Exemplo:

"019c96a0-ad10-7fab-c1d2-3b4c5d6e7f8a"

recipientLedgerId
string<uuid>

The recipient's Midaz ledger on a P2P between two ledgers of one organization. Absent on a P2P inside one ledger and on every TED.

Exemplo:

"0190a0e2-7b1c-7d3e-9f40-5a6b7c8d9e03"

ledgerGroupId
string<uuid>

The Midaz ledger group that a P2P between two ledgers posted as. Absent when the expiry recovery completed the transfer.

Exemplo:

"0190a0e2-7b1c-7d3e-9f40-5a6b7c8d9e10"