Sign in

v1

latestOpenAPI 3.1.02026-07-2440101174.2 KB

Feed de eventos

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

Query parameters

branchstring required

Agência da conta da qual se deseja obter os eventos.

accountstring required

Conta da qual se deseja obter o evento.

pagestring

Número da página da lista de eventos.

pageSizestring

Quantidade de eventos por página. Máximo de 100 itens.

includeDetailsboolean

Retorna o objeto data no corpo da resposta com os detalhes do evento.

beginDateTimestring

Data de início dos eventos a serem pesquisados, no formato yyyy-mm-dd. Caso necessário, poderá ser feito um filtro incluindo o horário, no formato yyyy-mm-ddThh:mm:ss. Utilize esse campo em conjunto com o parâmetro endDateTime para filtrar eventos por um range de datas.

endDateTimestring

Data do final dos eventos a serem pesquisados, no formato yyyy-mm-dd. Caso necessário, poderá ser feito um filtro incluindo o horário, no formato yyyy-mm-ddThh:mm:ss. Utilize esse campo em conjunto com o parâmetro beginDateTime para filtrar eventos por um range de datas.

cardProxystring[]

Informe o proxy (código identificador com 19 dígitos, gerado na solicitação de emissão de cartões) para pesquisar eventos de cartão.

eventNamestring[]

Nome do evento (ou eventos) sobre o qual se deseja obter informações. Confira os possíveis nomes na documentação Eventos.

Headers

x-correlation-idstring required
api-versionstring required

Response

200

OR

Example response

[
  {
    "aggregateId": "TRANSACTION_ID_b1b34eb6-6d34-4560-a0e9-190ad4fddf3b",
    "type": "TRANSACTION",
    "category": "EletronicTransfers",
    "documentNumber": "57650143000166",
    "bankBranch": "0001",
    "bankAccount": "0000",
    "amount": 5,
    "name": "CASH_IN_ACCOUNT",
    "timestamp": "2020-01-07T13:20:45.7991365Z",
    "data": {
      "ExternalTransactionId": "8aa812312312339e0f016f80150b6f1da5",
      "DepositTransactionId": "123123123-6d35-4560-a0e9-140ad4fddf3b",
      "ControlNumber": "STR2020013231231238",
      "TransactionAmount": 5,
      "ClearingAmount": 5,
      "Channel": "SPB",
      "SenderAccount": {
        "Agency": "1",
        "Account": "123123123",
        "Document": "61843186080",
        "IspbNumber": "18236120"
      },
      "RecipientAccount": {
        "Agency": "0001",
        "Account": "0000",
        "Document": "57650143000166",
        "IspbNumber": "13140088"
      },
      "CorrelationId": "299082a5-500a-4d1a-9c49-12312312312312",
      "Document": "57650143000166",
      "CompanyKey": "EXAMPLE"
    }
  }
]