List Transfers
Use this endpoint to retrieve a paginated list of transfers. You can filter by ledger, type, status, reconciliation status, date range, and amount range. The default limit is 50 items, with a maximum of 200. Only returns transfers belonging to the same organization.
Autorizações
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
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.
Parâmetros de consulta
Filter results by Midaz ledger, inside the X-Organization-Id scope. It matches the ledger that the transfer is filed under (the payer's ledger) or, on a P2P between two ledgers, the recipient's ledger. The filter applies to the page and to totalCount. A blank value applies no filter. A malformed UUID or the all-zeroes UUID returns 400 BTF-0001.
Filter results by transfer type. TED_IN does not select the customer credits that carry a TED_IN_STR type, nor the cross-core credits and returns received from the other core of your institution, which carry CROSS_CORE_IN. CROSS_CORE selects the cross-core TEDs sent.
The type of transfer. TED_OUT is an outgoing transfer to an external bank via JD SPB; the voluntary return of a TED IN is also a TED_OUT. TED_IN is an incoming transfer from an external bank. Each TED_IN_STR type is an incoming customer credit received as that STR message, for example TED_IN_STR0041 for an INSS payroll loan received as STR0041R2. P2P is a peer-to-peer transfer within the same institution (same ISPB). CROSS_CORE is a TED to an account that the other core of your institution holds, sent through the JD Courier. CROSS_CORE_IN is a cross-core credit, or the return of a cross-core TED, received from the other core.
TED_OUT, TED_IN, TED_IN_STR0005, TED_IN_STR0007, TED_IN_STR0029, TED_IN_STR0034, TED_IN_STR0037, TED_IN_STR0041, TED_IN_STR0051, P2P, CROSS_CORE, CROSS_CORE_IN "TED_OUT"
Filter results by transfer status. The current status of the transfer. For TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED, or FAILED. For P2P: CREATED → PROCESSING → COMPLETED or FAILED (PENDING is an SPB-specific state and does not apply to P2P). Transfers can be CANCELLED while in CREATED or PENDING status. For TED IN: RECEIVED → PROCESSING → COMPLETED or FAILED. A COMPLETED TED IN can also transition to FAILED in the event of a chargeback.
CREATED, PENDING, PROCESSING, COMPLETED, REJECTED, FAILED, CANCELLED, RECEIVED "COMPLETED"
Filter results by reconciliation status. MANUAL_REVIEW also selects the transfers stored as EXHAUSTED.
AWAITING, RESOLVED, REVERSING, REVERTED, MANUAL_REVIEW The start of the date range filter in RFC3339 format.
The end of the date range filter in RFC3339 format.
The minimum transfer amount to include in the results. Must be 0 or greater.
x >= 0The maximum transfer amount to include in the results. This filter has no upper bound.
x >= 0Maximum number of transfers to return.
1 <= x <= 200Number of transfers to skip.
x >= 0Sort direction for results ordered by createdAt.
asc, desc