Avistadocs

Search account transactions

GET /api/transactions

Returns transactions of the authenticated account in a friendly public format with pagination.

Features:

  • Amounts converted to BRL (2 decimal places)
  • Status and types mapped to display labels
  • Counterparty documents are masked
  • Maximum interval of 31 days between startDate and endDate

Authentication

Requires a Bearer token in the Authorization header.

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (1-indexed). Default: 1
sizeintegerNoNumber of records per page (max 100). Default: 20
statusstringNoFilter by status: PENDING, CONFIRMED, ERROR
typestringNoFilter by type: PAYMENT, WITHDRAW, REFUND_IN, REFUND_OUT
startDatestringNoStart date (ISO 8601, e.g.: 2025-01-01). Default: last 31 days
endDatestringNoEnd date (ISO 8601, e.g.: 2025-01-31). Default: current date
externalIdstringNoFilter by transaction externalId
endToEndIdstringNoFilter by transaction endToEndId (e2eId)

Status and Type Mapping

Original ValueDisplay Value
PENDINGPendente
CONFIRMEDConfirmado
ERRORError
PAYMENTPix in
WITHDRAWPix out
REFUND_INRefund in
REFUND_OUTRefund out

Movement Type: Pix in and Refund out = CREDIT; Pix out and Refund in = DEBIT.

Response (200)

{
  "data": [
    {
      "transactionId": "12345",
      "externalId": "ext-123456",
      "status": "Confirmado",
      "operationType": "Pix in",
      "movementType": "CREDIT",
      "originalAmount": 100.00,
      "feeAmount": 1.00,
      "finalAmount": 99.00,
      "endToEndId": "E12345678901234567890123456789012",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "processedAt": "2025-01-15T10:30:05.000Z",
      "counterpart": {
        "name": "João Silva",
        "document": "***.456.789-**",
        "bank": {
          "bankISPB": "00000000",
          "bankName": "Banco do Brasil",
          "bankCode": "001",
          "accountBranch": "0001",
          "accountNumber": "123456-7"
        }
      }
    }
  ],
  "metadata": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrevious": false
  }
}

Errors

StatusDescription
400Invalid parameters or date range exceeds 31 days
401Missing or invalid token

On this page