Pular para o conteúdo principal
GET
/
v1
/
transfers
Listar Transferências Pix
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "items": [
    {
      "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
      "endToEndId": "E123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "limit": 10,
  "offset": 0
}

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

​
X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de consulta

​
limit
integer
padrão:10

Número máximo de itens por página.

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

Número de itens a pular antes de começar a coletar o conjunto de resultados.

​
sort_order
enum<string>
padrão:asc

Direção da ordenação: asc ou desc.

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

Filtra pelo identificador end-to-end da transferência Pix.

​
status
enum<string>

Filtra pelo status da transferência (PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
​
type
enum<string>

Filtra pela direção da transferência (CASHOUT ou CASHIN).

Opções disponíveis:
CASHOUT,
CASHIN
​
modified_after
string

Filtrar por registros modificados após este timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

​
modified_before
string

Filtrar por registros modificados antes deste timestamp (formato RFC3339: 2024-01-15T10:30:00Z).

Resposta

Lista de transferências Pix recuperada com sucesso.

​
items
object[]
​
limit
integer
Exemplo:

10

​
offset
integer
Exemplo:

0