Query transaction status
GET /api/pix/transaction/{id}
Returns the current status of a PIX transaction with detailed information about amounts, counterparty, and timestamps.
The identifier can be:
- Numeric ID: Internal transaction identifier returned by Avista
- externalId: External identifier that you provided when creating the transaction
Authentication
Requires a Bearer token in the Authorization header.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Transaction ID (numeric) or externalId (string) |
Response (200)
| Field | Type | Description |
|---|---|---|
id | string | Transaction ID |
externalId | string | null | External ID provided by the client |
type | string | Transaction type: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT, TRANSFER |
status | string | Status: PENDING, CONFIRMED, ERROR |
originalAmount | string | Original amount in BRL |
feeAmount | string | Fee amount in BRL |
finalAmount | string | Final amount in BRL |
e2eId | string | null | PIX End-to-end ID |
counterpartName | string | null | Counterparty name |
counterpartDocument | string | null | Counterparty document (CPF/CNPJ) |
counterpartAccountBankCode | string | null | Counterparty bank code |
counterpartAccountBranch | string | null | Counterparty branch |
counterpartAccountNumber | string | null | Counterparty account number |
counterpartAccountIspb | string | null | Counterparty bank ISPB |
counterpartAccountBankName | string | null | Counterparty bank name |
createdAt | string | Creation date (ISO 8601) |
updatedAt | string | Update date (ISO 8601) |
processedAt | string | null | Processing date (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"
}Errors
| Status | Description |
|---|---|
| 401 | Missing or invalid token |
| 404 | Transaction not found |