Saltar al contenido principal
GET
/
v1
/
transactions
Listar transacciones
curl --request GET \
  --url https://plugin-pix-direct.api.lerian.net/v1/transactions \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://plugin-pix-direct.api.lerian.net/v1/transactions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://plugin-pix-direct.api.lerian.net/v1/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://plugin-pix-direct.api.lerian.net/v1/transactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://plugin-pix-direct.api.lerian.net/v1/transactions"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://plugin-pix-direct.api.lerian.net/v1/transactions")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://plugin-pix-direct.api.lerian.net/v1/transactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "txn_123456789",
    "accountId": "acc_123",
    "endToEndId": "E1234567820230615123456789012345",
    "status": "EXECUTED",
    "amount": 100.5,
    "description": "Pago",
    "flow": 1,
    "type": 1,
    "payer": {
      "name": "Maria Santos",
      "document": "98765432100"
    },
    "payee": {
      "name": "João Silva",
      "document": "12345678901"
    },
    "createdAt": "2023-06-15T10:30:00Z",
    "updatedAt": "2023-06-15T10:30:05Z"
  }
]

Autorizaciones

Authorization
string
header
requerido

Autenticación con token JWT Bearer. Obtén el token desde el endpoint /v1/login/oauth/access_token usando credenciales de cliente (clientId y clientSecret).

Incluye el token en el encabezado Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

El token expira después de 3600 segundos (1 hora).

Parámetros de consulta

account_id
string<uuid>

Filtra las transacciones por un UUID de cuenta específico.

end_to_end_id
string

Filtra por el identificador único de punta a punta de la transacción (E2E ID).

type
enum<integer>

Filtra por tipo de transacción. Usa el valor numérico: 1=PIX.

Identificador del tipo de transacción. Código numérico que especifica el tipo de transacción de pago.

Valores válidos:

  • 1 = PIX (Pago instantáneo a través del sistema Pix brasileño)
Opciones disponibles:
1
Ejemplo:

1

status
enum<string>

Filtra por estado de la transacción. Valores posibles: PENDING, PENDING_CONFIRM, EXECUTED, REVERSAL, REPROVED, SCHEDULE, CANCELLED, ERROR.

Estado del procesamiento de la transacción. Valores en texto que indican el estado actual de una transacción Pix.

Valores válidos:

  • PENDING = La transacción fue iniciada y está a la espera de procesamiento por el sistema de pagos
  • PENDING_CONFIRM = La transacción está esperando la confirmación final
  • EXECUTED = La transacción se completó con éxito y los fondos fueron transferidos
  • REVERSAL = La transacción fue revertida (reembolsada)
  • REPROVED = La transacción fue rechazada o no pasó la validación
  • SCHEDULE = La transacción está programada para una ejecución futura
  • CANCELLED = La transacción fue cancelada por el usuario antes de ejecutarse
  • ERROR = Ocurrió un error de procesamiento durante la ejecución de la transacción
Opciones disponibles:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Ejemplo:

"EXECUTED"

is_refund
boolean

Filtra transacciones de reembolso.

is_internal
boolean

Filtra transacciones internas.

created_at
string<date>

Filtra por fecha de creación.

updated_at
string<date>

Filtra por fecha de actualización.

Respuesta

Lista de transacciones recuperada correctamente

id
string
requerido

Identificador único de la transacción.

Ejemplo:

"txn_123456789"

accountId
string
requerido

Identificador de la cuenta asociada con la transacción.

Ejemplo:

"acc_123"

endToEndId
string
requerido

Identificador end-to-end de la transacción.

Ejemplo:

"E1234567820230615123456789012345"

status
enum<string>
requerido

Estado del procesamiento de la transacción. Valores en texto que indican el estado actual de una transacción Pix.

Valores válidos:

  • PENDING = La transacción fue iniciada y está a la espera de procesamiento por el sistema de pagos
  • PENDING_CONFIRM = La transacción está esperando la confirmación final
  • EXECUTED = La transacción se completó con éxito y los fondos fueron transferidos
  • REVERSAL = La transacción fue revertida (reembolsada)
  • REPROVED = La transacción fue rechazada o no pasó la validación
  • SCHEDULE = La transacción está programada para una ejecución futura
  • CANCELLED = La transacción fue cancelada por el usuario antes de ejecutarse
  • ERROR = Ocurrió un error de procesamiento durante la ejecución de la transacción
Opciones disponibles:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Ejemplo:

"EXECUTED"

amount
number<double>
requerido

Monto de la transacción.

Ejemplo:

100.5

description
string
requerido

Descripción de la transacción.

Ejemplo:

"Pago"

flow
enum<integer>
requerido

Dirección del flujo de la transacción. Código numérico que indica si el dinero ingresa, sale o se transfiere internamente.

Valores válidos:

  • 1 = CASH_IN (Recepción de pago: dinero que entra a la cuenta)
  • 2 = CASH_OUT (Envío de pago: dinero que sale de la cuenta)
  • 3 = INTRA_PSP (Transferencia interna dentro del mismo proveedor de servicios de pago)
Opciones disponibles:
1,
2,
3
Ejemplo:

1

type
enum<integer>
requerido

Identificador del tipo de transacción. Código numérico que especifica el tipo de transacción de pago.

Valores válidos:

  • 1 = PIX (Pago instantáneo a través del sistema Pix brasileño)
Opciones disponibles:
1
Ejemplo:

1

payer
object
requerido
payee
object
requerido
createdAt
string<date-time>
requerido

Marca de tiempo de creación de la transacción.

Ejemplo:

"2023-06-15T10:30:00Z"

updatedAt
string<date-time>
requerido

Marca de tiempo de la última actualización de la transacción.

Ejemplo:

"2023-06-15T10:30:05Z"