Consultar estado de transacción
GET /api/pix/transaction/{id}
Retorna el estado actual de una transacción PIX con información detallada sobre montos, contraparte y marcas de tiempo.
El identificador puede ser:
- ID numérico: Identificador interno de la transacción retornado por Avista
- externalId: Identificador externo que usted proporcionó al crear la transacción
Autenticación
Requiere un Bearer token en el header Authorization.
Parámetros de ruta
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
id | string | Sí | ID de la transacción (numérico) o externalId (cadena) |
Respuesta (200)
| Campo | Tipo | Descripción |
|---|---|---|
id | string | ID de la transacción |
externalId | string | null | ID externo proporcionado por el cliente |
type | string | Tipo de transacción: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT, TRANSFER |
status | string | Estado: PENDING, CONFIRMED, ERROR |
originalAmount | string | Monto original en BRL |
feeAmount | string | Monto de la tarifa en BRL |
finalAmount | string | Monto final en BRL |
e2eId | string | null | ID End-to-end de PIX |
counterpartName | string | null | Nombre de la contraparte |
counterpartDocument | string | null | Documento de la contraparte (CPF/CNPJ) |
counterpartAccountBankCode | string | null | Código del banco de la contraparte |
counterpartAccountBranch | string | null | Sucursal de la contraparte |
counterpartAccountNumber | string | null | Número de cuenta de la contraparte |
counterpartAccountIspb | string | null | ISPB del banco de la contraparte |
counterpartAccountBankName | string | null | Nombre del banco de la contraparte |
createdAt | string | Fecha de creación (ISO 8601) |
updatedAt | string | Fecha de actualización (ISO 8601) |
processedAt | string | null | Fecha de procesamiento (ISO 8601) |
{
"id": "123",
"externalId": "ext-001",
"type": "PAYMENT",
"status": "CONFIRMED",
"originalAmount": "100.00",
"feeAmount": "1.50",
"finalAmount": "98.50",
"e2eId": "E00416968202512121343VX5Sx8fIpkY",
"counterpartName": "John Marvin",
"counterpartDocument": "12312312387",
"counterpartAccountBankCode": "001",
"counterpartAccountBranch": "0001",
"counterpartAccountNumber": "123456-7",
"counterpartAccountIspb": "00000000",
"counterpartAccountBankName": "Banco do Brasil",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:35:00.000Z",
"processedAt": "2024-01-15T10:35:00.000Z"
}Errores
| Estado | Descripción |
|---|---|
| 401 | Token faltante o inválido |
| 404 | Transacción no encontrada |