Consulta de eventos
stable
Este endpoint permite realizar a consulta de eventos de uma conta específica.
Importante
A consulta de eventos retorna no máximo 10.000 eventos por vez. Quando é gerado um novo evento, para que este seja retornado na consulta, o mais antigo é excluído. Portanto, recomendamos salvar o retorno da última consulta realizada no fim do dia em uma base de dados própria, para que o conteúdo não se perca com a atualização dos eventos.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/events?branch={{branchNumber}}&account={{accountNumber}}&page={{pageNumber}}&pageSize={{eventsPerPage}}&includeDetails={{true}}&beginDateTime={{AAAA-MM-DD}}&endDateTime={{AAAA-MM-DD}}&cardProxy={{proxyNumber}}}&eventName={{eventName}}
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/events?branch={{branchNumber}}&account={{accountNumber}}&page={{pageNumber}}&pageSize={{eventsPerPage}}&includeDetails={{true}}&beginDateTime={{AAAA-MM-DD}}&endDateTime={{AAAA-MM-DD}}&cardProxy={{proxyNumber}}}&eventName={{eventName}}'\
--header 'Accept: application/json'\
--header 'api-version: 1.0'\
--header 'authorization: Bearer {{Token}}' \
--header 'x-correlation-id: {{Guid}}'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
events.read | Concede acesso para consultar eventos de uma conta específica. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-correlation-id | Obrigatório. Informe um GUID, sendo um novo cada requisição. |
Parâmetros da rota (Path)
No path desta requisição envie as seguintes queries:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
branch | query | Obrigatório. Número da agência. | --- |
account | query | Obrigatório. Número da conta. | --- |
page | query | Número da página que deseja visualizar. | --- |
pageSize | query | Número de eventos por página que a consulta deve retornar. | Máximo de 100 itens. |
includeDetails | query | Insira o valor true para obter o objeto data no corpo da resposta, com os detalhes do evento. | --- |
beginDateTime | query | Data de início dos eventos que deseja consultar. Utilize esse campo em conjunto com o endDateTime para filtrar eventos por um range de datas. | Formato AAAA-MM-DD. |
endDateTime | query | Data final dos eventos que deseja consultar. | Formato AAAA-MM-DD. |
cardProxy | query | Proxy (código identificador com 19 dígitos, gerado na solicitação de emissão de cartões) para pesquisar eventos de cartão. Observação: em sandbox a consulta por proxy não retornará eventos, visto que nesse ambiente não ocorrem movimentações reais com cartão. | --- |
eventName | query | Nome do evento sobre o qual deseja obter informações. | Confira os possíveis nomes na documentação Eventos. |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará que a solicitação foi aceita com sucesso e trará uma lista de eventos e suas informações em formato JSON.
[
{
"aggregateId": "PIX_TRANSACTION_ID_96000a91-75aa-4989-935f-e94de7608fe4",
"type": "TRANSACTION",
"category": "EletronicTransfers",
"documentNumber": "47742663023",
"bankBranch": "0001",
"bankAccount": "15164",
"amount": 1,
"index": "cash-in",
"name": "PIX_CASH_IN_ACCOUNT",
"timestamp": "2021-10-25T14:36:00+00:00",
"data": {
"TotalRefundedAmount": 1,
"DepositTransactionId": "96000a91-75aa-4989-935f-e94de7608fe4",
"ControlNumber": null,
"TransactionAmount": 1,
"ClearingAmount": 1,
"OverLimitAmount": 0,
"AddressKey": null,
"Description": "DESCRIÇÃO",
"Channel": "INTERNAL_SPI",
"EndToEndId": null,
"PixTransactionId": "00000000-0000-0000-0000-000000000000",
"SenderAccount": {
"Agency": "0001",
"Account": "15164",
"Document": "47742663023",
"IspbNumber": "13140088",
"Name": "Nísia Floresta"
},
"RecipientAccount": {
"Agency": "0001",
"Account": "540108",
"Document": "09992220074",
"IspbNumber": "13140088",
"Name": "Maria Quitéria de Jesus"
},
"IsPixDeposit": true,
"CorrelationId": null,
"Document": "47742663023",
"CompanyKey": "SDB2_BANKLYDELIVERY",
"EventDateTime": "2021-10-25T14:36:00.039+00:00"
},
"status": "ACTIVE"
}
]
Importante
Conheça o detalhamento dos campos retornados consultando a documentação de cada evento específico.
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status Code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | 404 | ‘{parâmetro}’ must not be empty. | Esse erro se refere à obrigatoriedade do envio de valores nos campos branch e account. |
| 400 | 404 | ‘{parâmetro}’ must be greater than '{valor}'. | Esse indica que os valores dos campos page e pageSize devem ser maiores que zero. |
| 404 | 404 | Account does not belong to this company. | A conta informada não pertence a esse parceiro. |
| 404 | 404 | Account not find. | A conta informada não foi encontrada. |
Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Updated 6 months ago