Safira Paydocs

Consultar estado de transacción

GET /api/pix/transaction/{id}

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)

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
originalAmountstringMonto original en BRL
feeAmountstringMonto de la tarifa en BRL
finalAmountstringMonto 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)
{
  "id": "123",
  "externalId": "ext-001",
  "type": "PAYMENT",
  "status": "CONFIRMED",
  "originalAmount": "100.00",
  "feeAmount": "1.50",
  "finalAmount": "98.50",
  "e2eId": "E00416968202512121343VX5Sx8fIpkY",
  "counterpartName": "John Marvin",
  "counterpartDocument": "12312312387",
  "counterpartAccountBankCode": "001",
  "counterpartAccountBranch": "0001",
  "counterpartAccountNumber": "123456-7",
  "counterpartAccountIspb": "00000000",
  "counterpartAccountBankName": "Banco do Brasil",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z",
  "processedAt": "2024-01-15T10:35:00.000Z"
}

Errores

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

En esta página