Avistadocs

Consultar estado de transacción

GET /api/pix/transaction/{id}

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

Requiere un Bearer token en el header Authorization. Vea Generar Token para obtener uno.

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ámetroTipoRequeridoDescripción
idstringID de la transacción (numérico) o externalId (cadena)

Ejemplos 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());

Respuesta (200)

CampoTipoDescripción
idstringID de la transacción
externalIdstring | nullID externo proporcionado por el cliente
typestringTipo de transacción: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT, TRANSFER
statusstringEstado: PENDING, CONFIRMED, ERROR
originalAmountnumberMonto original en BRL
feeAmountnumberMonto de la tarifa en BRL
finalAmountnumberMonto final en BRL
e2eIdstring | nullID End-to-end de PIX
counterpartNamestring | nullNombre de la contraparte
counterpartDocumentstring | nullDocumento de la contraparte (CPF/CNPJ)
counterpartAccountBankCodestring | nullCódigo del banco de la contraparte
counterpartAccountBranchstring | nullSucursal de la contraparte
counterpartAccountNumberstring | nullNúmero de cuenta de la contraparte
counterpartAccountIspbstring | nullISPB del banco de la contraparte
counterpartAccountBankNamestring | nullNombre del banco de la contraparte
createdAtstringFecha de creación (ISO 8601)
updatedAtstringFecha de actualización (ISO 8601)
processedAtstring | nullFecha de procesamiento (ISO 8601)
refundedbooleanIndica si la transacción fue reembolsada (parcial o totalmente). True si hay al menos un reembolso CONFIRMED vinculado.
partiallyRefundedbooleanIndica si la transacción fue reembolsada parcialmente (refundedAmount > 0 y refundedAmount < amount).
refundedAmountnumberSuma de los reembolsos CONFIRMED en reales. 0 cuando no hay reembolso o el tipo no es reembolsable.
refundableAmountnumberSaldo aún reembolsable en reales. 0 para PENDING/ERROR o tipos no reembolsables.
relatedTransactionsarrayTransacciones relacionadas. Bidireccional: para PAYMENT/WITHDRAW lista los reembolsos (children); para REFUND_IN/REFUND_OUT lista el 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

El campo relatedTransactions es bidireccional:

  • Cuando consultas una transacción PAYMENT o WITHDRAW, lista todos los reembolsos vinculados (REFUND_IN o REFUND_OUT), en cualquier estado.
  • Cuando consultas una transacción REFUND_IN o REFUND_OUT, lista la transacción original (parent), con 1 elemento en el array.
  • Para otros tipos (TRANSFER, o transacciones sin relaciones registradas), retorna [].

Solo reembolsos con status: "CONFIRMED" entran en refundedAmount y refundableAmount. Reembolsos PENDING o ERROR aparecen en relatedTransactions pero no afectan los totales.

Errores

EstadoDescripción
401Token faltante o inválido
404Transacción no encontrada

En esta página