Consultar transação por chave PIX e identificador
GET /api/pix/transactions/pix-key/{pixKey}/{identifier}
GET https://<api-host>/api/pix/transactions/pix-key/{pixKey}/{identifier}Requer um Bearer token no header Authorization. Veja Gerar Token para obter um.
Retorna uma transação específica associada a uma chave PIX, buscando pelo identificador fornecido.
Lógica de resolução do identificador: o valor informado é comparado simultaneamente contra endToEndId (e2eId do PIX), externalId e id numérico. Na prática não há ambiguidade: o formato de cada tipo é único (e2eId começa com E + 32 caracteres alfanuméricos; id é puramente numérico; externalId é qualquer outra string).
Autenticação
Requer token Bearer no header Authorization.
Path Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pixKey | string | Sim | Chave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP) |
identifier | string | Sim | Identificador da transação: comparado contra endToEndId, externalId ou id numérico |
Exemplos de Código
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);Response (200)
{
"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 traz o valor efetivamente pago (antes da confirmação, o valor cobrado). amountPaid é null até a confirmação, e mismatchAmount traz a diferença entre cobrado e pago (null sem divergência; positivo = pagou a menos, negativo = pagou a mais).
Erros
| Status | Descrição |
|---|---|
| 401 | Token não fornecido ou inválido |
| 404 | Transação não encontrada para a chave PIX e identificador informados |