Consultar status de transação

GET /api/pix/transaction/{id}

GET https://api.avista.global/api/pix/transaction/{id}

Requer um Bearer token no header Authorization. Veja Gerar Token para obter um.

Retorna o status atual de uma transação PIX com informações detalhadas sobre valores, contraparte e timestamps.

O identificador pode ser:

ID numérico: Identificador interno da transação retornado pela Avista
externalId: Identificador externo que você forneceu na criação da transação

Autenticação

Requer token Bearer no header Authorization.

Path Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID da transação (numérico) ou externalId (string)

Exemplos de Código

cURL

curl -X GET "https://api.avista.global/api/pix/transaction/txn_abc123" \
  -H "Authorization: Bearer $AVISTA_TOKEN"

const axios = require('axios');

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

import os, requests

response = requests.get(
    'https://api.avista.global/api/pix/transaction/txn_abc123',
    headers={'Authorization': f'Bearer {os.environ["AVISTA_TOKEN"]}'},
)
print(response.json())

$ch = curl_init('https://api.avista.global/api/pix/transaction/txn_abc123');
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/transaction/txn_abc123"))
    .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)

Campo	Tipo	Descrição
`id`	string	ID da transação
`externalId`	string \| null	External ID fornecido pelo cliente
`type`	string	Tipo da transação: `PAYMENT`, `WITHDRAW`, `REFUND_IN`, `REFUND_OUT`, `TRANSFER`
`status`	string	Status: `PENDING`, `CONFIRMED`, `ERROR`
`originalAmount`	number	Valor original em reais
`feeAmount`	number	Taxa em reais
`finalAmount`	number	Valor final em reais
`e2eId`	string \| null	End-to-end ID do PIX
`counterpartName`	string \| null	Nome da contraparte
`counterpartDocument`	string \| null	Documento da contraparte (CPF/CNPJ)
`counterpartAccountBankCode`	string \| null	Código do banco da contraparte
`counterpartAccountBranch`	string \| null	Agência da contraparte
`counterpartAccountNumber`	string \| null	Número da conta da contraparte
`counterpartAccountIspb`	string \| null	ISPB do banco da contraparte
`counterpartAccountBankName`	string \| null	Nome do banco da contraparte
`createdAt`	string	Data de criação (ISO 8601)
`updatedAt`	string	Data de atualização (ISO 8601)
`processedAt`	string \| null	Data de processamento (ISO 8601)
`refunded`	boolean	Indica se a transação foi reembolsada (parcial ou totalmente). True se há ao menos um refund CONFIRMED vinculado.
`partiallyRefunded`	boolean	Indica se a transação foi reembolsada parcialmente (`refundedAmount > 0` e `refundedAmount < amount`).
`refundedAmount`	number	Soma dos refunds CONFIRMED em reais. `0` quando não há refund ou tipo não-reembolsável.
`refundableAmount`	number	Saldo ainda reembolsável em reais. `0` para PENDING/ERROR ou tipos não-reembolsáveis.
`relatedTransactions`	array	Transações relacionadas. Bidirecional: para PAYMENT/WITHDRAW lista refunds (children); para REFUND_IN/REFUND_OUT lista o parent.

{
  "id": "123",
  "externalId": "ext-001",
  "type": "PAYMENT",
  "status": "CONFIRMED",
  "originalAmount": 100,
  "feeAmount": 1.5,
  "finalAmount": 98.5,
  "e2eId": "E00416968202512121343VX5Sx8fIpkY",
  "counterpartName": "John Marvin",
  "counterpartDocument": "12312312387",
  "counterpartAccountBankCode": "001",
  "counterpartAccountBranch": "0001",
  "counterpartAccountNumber": "123456-7",
  "counterpartAccountIspb": "00000000",
  "counterpartAccountBankName": "Banco do Brasil",
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-15T10:35:00.000Z",
  "processedAt": "2026-01-15T10:35:00.000Z",
  "refunded": true,
  "partiallyRefunded": true,
  "refundedAmount": 30,
  "refundableAmount": 70,
  "relatedTransactions": [
    {
      "id": "456",
      "externalId": "ext-refund-001",
      "type": "REFUND_IN",
      "status": "CONFIRMED",
      "amount": 30,
      "e2eId": "E0041696820260120ABCxyz1234567",
      "createdAt": "2026-01-20T14:22:00.000Z"
    }
  ]
}

Reembolsos correlacionados

O campo relatedTransactions é bidirecional:

Quando você consulta uma transação PAYMENT ou WITHDRAW, ele lista todos os reembolsos vinculados (REFUND_IN ou REFUND_OUT), em qualquer status.
Quando você consulta uma transação REFUND_IN ou REFUND_OUT, ele lista a transação original (parent), com 1 item no array.
Para outros tipos (TRANSFER, ou transações sem relação registrada), retorna [].

Apenas reembolsos com status: "CONFIRMED" entram em refundedAmount e refundableAmount. Reembolsos PENDING ou ERROR aparecem em relatedTransactions mas não afetam os totais.

Erros

Status	Descrição
401	Token não fornecido ou inválido
404	Transação não encontrada