Consultar status de transação
GET /api/pix/transaction/{id}
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) |
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 | string | Valor original em reais |
feeAmount | string | Taxa em reais |
finalAmount | string | 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) |
{
"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"
}Erros
| Status | Descrição |
|---|---|
| 401 | Token não fornecido ou inválido |
| 404 | Transação não encontrada |