---
title: "Feed de eventos"
method: GET
path: "/events"
---

# Feed de eventos

`GET /events`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/events`
- Auth: none required

<div class="bkly-ref-description">
Consulte eventos relativos a uma conta específica.
</div>

## Query parameters

- `branch` string, required
- `account` string, required
- `page` string
- `pageSize` string
- `includeDetails` boolean
- `beginDateTime` string
- `endDateTime` string
- `cardProxy` string[]
- `eventName` string[]

## Headers

- `x-correlation-id` string, required
- `api-version` string, required

## Response `200`

200

- union
  - object[]
    - `aggregateId` string
    - `type` string
    - `category` string
    - `documentNumber` string
    - `bankBranch` string
    - `bankAccount` string
    - `amount` integer
    - `name` string
    - `timestamp` string
    - `data` object
      - `ExternalTransactionId` string
      - `DepositTransactionId` string
      - `ControlNumber` string
      - `TransactionAmount` integer
      - `ClearingAmount` integer
      - `OverLimitAmount` integer
      - `Channel` string
      - `SenderAccount` object
        - `Agency` string
        - `Account` string
        - `Document` string
        - `IspbNumber` string
        - `Name` unknown
      - `RecipientAccount` object
        - `Agency` string
        - `Account` string
        - `Document` string
        - `IspbNumber` string
        - `Name` unknown
      - `CorrelationId` string
      - `Document` string
      - `CompanyKey` string
  - object[]
    - `aggregateId` string
    - `type` string
    - `category` string
    - `description` string
    - `documentNumber` string
    - `bankBranch` string
    - `bankAccount` string
    - `amount` number
    - `name` string
    - `timestamp` string
    - `data` object
      - `TransactionReceipt` object
        - `AuthenticationCode` string
        - `TransactionDate` string
        - `DestinationName` string
        - `DestinationAgency` string
        - `DestinationAccount` string
        - `DestinationDocument` string
        - `DestinationBankName` string
        - `DestinationCompe` string
        - `Amount` number
        - `Description` string

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403
- `404`: 404

---

[API](https://skmtc.dev/bankly/apis/sandbox-api-mtls.md) - [All operations](https://skmtc.dev/bankly/apis/sandbox-api-mtls/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/sandbox-api-mtls/revisions/63852a068e2f?raw)