Saltar al contenido principal
GET
/
v1
/
transactions
/
{transactionId}
Recuperar estado de la transacción
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "txn_123456789",
  "jdpiRequestId": "req_abc123xyz",
  "endToEndId": "E1234567820230615123456789012345",
  "status": "EXECUTED",
  "payer": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "amount": 100.5,
  "description": "Pago por servicios"
}

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 ruta

​
transactionId
string
requerido

Identificador de la transacción.

Respuesta

Detalles de la transacción recuperados correctamente

​
id
string
requerido

Identificador único de la transacción.

Ejemplo:

"txn_123456789"

​
jdpiRequestId
string
requerido

Identificador de la solicitud JDPI.

Ejemplo:

"req_abc123xyz"

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

​
payer
object
requerido

Información de la cuenta bancaria.

​
payee
object
requerido

Información de la cuenta bancaria.

​
amount
number<double>
requerido

Monto de la transacción.

Ejemplo:

100.5

​
description
string
requerido

Descripción de la transacción.

Ejemplo:

"Pago por servicios"