Consultar transacción por clave PIX e identificador

GET /api/pix/transactions/pix-key/{pixKey}/{identifier}Copy Anchor Link

GET https://<api-host>/api/pix/transactions/pix-key/{pixKey}/{identifier}

Retorna una transacción específica asociada a una clave PIX, buscada por el identificador proporcionado.

Lógica de resolución de identificador: El valor proporcionado se compara simultáneamente contra endToEndId (PIX e2eId), externalId e id numérico. En la práctica no hay ambigüedad: cada tipo tiene un formato único (e2eId comienza con E + 32 caracteres alfanuméricos; id es puramente numérico; externalId es cualquier otra cadena).

AutenticaciónCopy Anchor Link

Requiere un Bearer token en el header Authorization.

Parámetros de rutaCopy Anchor Link

Ejemplos de CódigoCopy Anchor Link

curl -X GET "https://<api-host>/api/pix/transactions/pix-key/12345678901/ext-123456" \
  -H "Authorization: Bearer $PIX_API_TOKEN"

const axios = require('axios');

const response = await axios.get('https://<api-host>/api/pix/transactions/pix-key/12345678901/ext-123456', {
  headers: { 'Authorization': `Bearer ${process.env.PIX_API_TOKEN}` },
});
console.log(response.data);

Respuesta (200)Copy Anchor Link

{
  "transactionId": "12345",
  "externalId": "ext-123456",
  "status": "Confirmado",
  "operationType": "Pix in",
  "movementType": "CREDIT",
  "originalAmount": 100.00,
  "feeAmount": 1.00,
  "finalAmount": 99.00,
  "amountPaid": 100.00,
  "mismatchAmount": null,
  "endToEndId": "E12345678901234567890123456789012",
  "createdAt": "2025-01-15T10:30:00.000Z",
  "processedAt": "2025-01-15T10:30:05.000Z",
  "counterpart": {
    "name": "João Silva",
    "document": "***.456.789-**",
    "bank": {
      "bankISPB": "00000000",
      "bankName": "Banco do Brasil",
      "bankCode": "001",
      "accountBranch": "0001",
      "accountNumber": "123456-7"
    }
  }
}

originalAmount trae el monto efectivamente pagado (antes de la confirmación, el monto cobrado). amountPaid es null hasta la confirmación, y mismatchAmount trae la diferencia entre lo cobrado y lo pagado (null sin divergencia; positivo = pagó de menos, negativo = pagó de más).

ErroresCopy Anchor Link