Pular para o conteúdo principal
GET
Listar Transferências

Autorizações

Authorization
string
header
obrigatório

Autenticação por token JWT Bearer. O tenantId é derivado do token bearer ou do contexto de requisição autenticado e não é fornecido por meio do X-Organization-Id.

Cabeçalhos

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

Escopo da organização Midaz para a requisição, usado para chamadas downstream ao CRM, Fees e Midaz. Obrigatório nas rotas de transferência com escopo de organização em todos os modos de implantação; um valor ausente ou que não seja UUID retorna 400. Este não é o identificador do tenant — o tenantId é derivado do JWT bearer ou do contexto autenticado, nunca deste cabeçalho. Workers em segundo plano (poller de TED IN, conciliação) não possuem cabeçalho de requisição e, no modo single-tenant, recorrem à variável de ambiente ORGANIZATION_ID da implantação.

Parâmetros de consulta

type
enum<string>

Filtrar resultados por tipo de transferência. O tipo de transferência. TED_OUT é uma transferência de saída para um banco externo via JD SPB. TED_IN é uma transferência de entrada de um banco externo. P2P é uma transferência ponto a ponto dentro da mesma instituição (mesmo ISPB).

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

"TED_OUT"

status
enum<string>

Filtrar resultados por status da transferência. O status atual da transferência. Para TED OUT: CREATED → PENDING → PROCESSING → COMPLETED, REJECTED ou FAILED. Para P2P: CREATED → PROCESSING → COMPLETED ou FAILED (PENDING é um estado específico do SPB e não se aplica a P2P). Transferências podem ser canceladas (CANCELLED) enquanto estiverem com status CREATED ou PENDING. Para TED IN: RECEIVED → PROCESSING → COMPLETED ou FAILED. Um TED IN em status COMPLETED também pode transitar para FAILED em caso de estorno.

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

"COMPLETED"

createdFrom
string<date-time>

O início do filtro de intervalo de datas no formato RFC3339.

createdTo
string<date-time>

O fim do filtro de intervalo de datas no formato RFC3339.

minAmount
number<decimal>

O valor mínimo da transferência a ser incluído nos resultados. Deve ser 0 ou maior.

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

O valor máximo da transferência a ser incluído nos resultados. Este filtro não possui limite superior.

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

Número máximo de transferências a retornar.

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

Número de transferências a pular.

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

Direção de ordenação para resultados ordenados por createdAt.

Opções disponíveis:
asc,
desc

Resposta

Indica que a solicitação foi bem-sucedida e as transferências correspondentes são retornadas.

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