Saltar al contenido principal
GET
/
v1
/
transfers
Listar transferencias 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
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
X-Account-Id
string
requerido

Identificador único de la cuenta del Ledger de Midaz (formato UUID).

Parámetros de consulta

​
limit
integer
predeterminado:10

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

Rango requerido: 1 <= x <= 100
​
offset
integer
predeterminado:0

Número de elementos que se omiten antes de comenzar a recopilar el conjunto de resultados.

​
sort_order
enum<string>
predeterminado:asc

Dirección de ordenamiento: asc o desc.

Opciones disponibles:
asc,
desc
​
end_to_end
string

Filtra por el identificador end-to-end de la transferencia Pix.

​
status
enum<string>

Filtra por el estado de la transferencia (PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

Opciones disponibles:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
​
type
enum<string>

Filtra por la dirección de la transferencia (CASHOUT o CASHIN).

Opciones disponibles:
CASHOUT,
CASHIN
​
modified_after
string

Filtra por registros modificados después de esta marca de tiempo (formato RFC3339: 2024-01-15T10:30:00Z).

​
modified_before
string

Filtra por registros modificados antes de esta marca de tiempo (formato RFC3339: 2024-01-15T10:30:00Z).

Respuesta

Lista de transferencias Pix recuperada correctamente.

​
items
object[]
​
limit
integer
Ejemplo:

10

​
offset
integer
Ejemplo:

0