Consultar transação por chave PIX e identificador

GET /api/pix/transactions/pix-key/{pixKey}/{identifier}

GET https://api.avista.global/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.

Logica de resolução do identificador: O valor informado e comparado simultaneamente contra endToEndId (e2eId do PIX), externalId e id numérico. Na pratica não ha ambiguidade: o formato de cada tipo e único (e2eId comeca com E + 32 chars alfanuméricos; id e puramente numérico; externalId e 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

curl -X GET "https://api.avista.global/api/pix/transactions/pix-key/12345678901/ext-123456" \
  -H "Authorization: Bearer $AVISTA_TOKEN"

const axios = require('axios');

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

import os, requests

response = requests.get(
    'https://api.avista.global/api/pix/transactions/pix-key/12345678901/ext-123456',
    headers={'Authorization': f'Bearer {os.environ["AVISTA_TOKEN"]}'},
)
print(response.json())

$ch = curl_init('https://api.avista.global/api/pix/transactions/pix-key/12345678901/ext-123456');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('AVISTA_TOKEN'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.avista.global/api/pix/transactions/pix-key/12345678901/ext-123456"))
    .header("Authorization", "Bearer " + System.getenv("AVISTA_TOKEN"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response (200)

{
  "transactionId": "12345",
  "externalId": "ext-123456",
  "status": "Confirmado",
  "operationType": "Pix in",
  "movementType": "CREDIT",
  "originalAmount": 100.00,
  "feeAmount": 1.00,
  "finalAmount": 99.00,
  "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"
    }
  }
}

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