Saltar al contenido principal
GET
/
v1
/
transactions
Listar transacciones
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/transactions \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
  }
]

Authorizations

​
Authorization
string
header
required

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).

Query Parameters

​
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.

Opciones disponibles:
1
Example:

1

​
status
enum<string>

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

Opciones disponibles:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Example:

"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.

Response

Lista de transacciones recuperada correctamente

​
id
string
required

Identificador único de la transacción.

Example:

"txn_123456789"

​
accountId
string
required

Identificador de la cuenta asociada con la transacción.

Example:

"acc_123"

​
endToEndId
string
required

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

Example:

"E1234567820230615123456789012345"

​
status
enum<string>
required

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
Example:

"EXECUTED"

​
amount
number
required

Monto de la transacción.

Example:

100.5

​
description
string
required

Descripción de la transacción.

Example:

"Pago"

​
flow
enum<integer>
required

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
Example:

1

​
type
enum<integer>
required

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
Example:

1

​
payer
object
required
​
payee
object
required
​
createdAt
string<date-time>
required

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

Example:

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

​
updatedAt
string<date-time>
required

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

Example:

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