Skip to main content
GET
/
api
/
transactions
Buscar transações da conta
curl --request GET \
  --url https://api.avista.global/api/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "transactionId": "12345",
      "externalId": "ext-123456",
      "status": "Confirmado",
      "operationType": "Pix in",
      "movementType": "CREDIT",
      "originalAmount": 100,
      "feeAmount": 1,
      "finalAmount": 99,
      "endToEndId": "E12345678901234567890123456789012",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "counterpart": {
        "name": "João Silva",
        "document": "***.456.789-**",
        "bank": {
          "bankISPB": "00000000",
          "bankName": "Banco do Brasil",
          "bankCode": "001",
          "accountBranch": "0001",
          "accountNumber": "123456-7"
        }
      },
      "processedAt": "2025-01-15T10:30:05.000Z"
    }
  ],
  "metadata": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrevious": false
  }
}

Authorizations

Authorization
string
header
required

Enter JWT token

Query Parameters

page
integer
default:1

Número da página (1-indexed)

Required range: x >= 1
Example:

1

size
integer
default:20

Quantidade de registros por página (máximo 100)

Required range: 1 <= x <= 100
Example:

20

status
enum<string>

Filtro por status da transação

Available options:
PENDING,
CONFIRMED,
ERROR
Example:

"CONFIRMED"

type
enum<string>

Filtro por tipo de transação

Available options:
PAYMENT,
WITHDRAW,
REFUND_IN,
REFUND_OUT
Example:

"PAYMENT"

startDate
string<date>

Data inicial para filtro (ISO 8601). Se não informado, usa últimos 31 dias.

Example:

"2025-01-01"

endDate
string<date>

Data final para filtro (ISO 8601). Se não informado, usa data atual.

Example:

"2025-01-31"

externalId
string

Filtro por externalId da transação

Example:

"ext-123456"

endToEndId
string

Filtro por endToEndId (e2eId) da transação

Example:

"E12345678901234567890123456789012"

Response

Lista de transações retornada com sucesso

data
object[]
required

Lista de transações

metadata
object
required

Metadados de paginação