Skip to main content
GET
List Transfers

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.

Parâmetros de consulta

​
type
enum<string>

Filter results by transfer type. The type of transfer. TED_OUT is an outgoing transfer to an external bank via JD SPB. TED_IN is an incoming transfer from an external bank. P2P is a peer-to-peer transfer within the same institution (same ISPB).

Opções disponíveis:
TED_OUT,
TED_IN,
P2P
Exemplo:

"TED_OUT"

​
status
enum<string>

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.

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

"COMPLETED"

​
createdFrom
string<date-time>

The start of the date range filter in RFC3339 format.

​
createdTo
string<date-time>

The end of the date range filter in RFC3339 format.

​
minAmount
number<decimal>

The minimum transfer amount to include in the results. Must be 0 or greater.

Intervalo obrigatório: x >= 0
​
maxAmount
number<decimal>

The maximum transfer amount to include in the results. This filter has no upper bound.

Intervalo obrigatório: x >= 0
​
limit
integer
padrão:50

Maximum number of transfers to return.

Intervalo obrigatório: 1 <= x <= 200
​
offset
integer
padrão:0

Number of transfers to skip.

Intervalo obrigatório: x >= 0
​
sortDirection
enum<string>
padrão:desc

Sort direction for results ordered by createdAt.

Opções disponíveis:
asc,
desc

Resposta

Indicates that the request was successful and the matching transfers are returned.

​
items
object[]
obrigatório
​
pagination
object
obrigatório