Pular para o conteúdo principal
GET
List outgoing/internal transfers (cursor pagination)

Autorizações

Authorization
string
header
obrigatório

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Cabeçalhos

X-Request-Id
string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Parâmetros de consulta

limit
integer<int64>
padrão:20

Maximum items per page

Intervalo obrigatório: 1 <= x <= 100
cursor
string

Opaque cursor returned in next_cursor/prev_cursor

Maximum string length: 512
sort_order
enum<string>
padrão:desc

Order by creation date: desc (newest first, default) or asc.

Opções disponíveis:
asc,
desc
start_date
string

Created on or after (YYYY-MM-DD)

end_date
string

Created on or before (YYYY-MM-DD)

status
enum<string>

Filters by current state.

Opções disponíveis:
CREATED,
RESERVED,
SUBMITTED,
PENDING_STR,
SETTLED,
REJECTED,
CANCELLED,
AWAITING_RECONCILIATION,
EXHAUSTED
type
enum<string>

Filters by path: TED (another institution) or INTERNAL (your own institution).

Opções disponíveis:
TED,
INTERNAL
account_id
string<uuid>

Source account (UUID)

client_reference
string

Filters by the requester reference sent when the transfer was created (clientReference).

Maximum string length: 64

Resposta

Page of transfers. Follow next_cursor until it is null.

Page of transfers with cursor pagination. Follow next_cursor until it is null.

items
object[]
obrigatório

Transfers on the page.

limit
integer<int64>
obrigatório

Actual page size, already capped at the contract maximum — not necessarily the requested value.

next_cursor
string | null
obrigatório

Token of the next page; null when there is none.

prev_cursor
string | null
obrigatório

Token of the previous page; null when there is none.