Dados para informe de rendimentos

📘

Nota

A documentação da nova versão deste endpoint está disponível na aba v2 deste manual. Para acessá-la, basta selecionar a versão desejada (v2) no menu suspenso localizado no canto superior esquerdo da página.

Este endpoint possibilita que nossos parceiros tenham acesso aos dados de rendimento de todos os seus clientes. A partir das informações obtidas, os parceiros poderão compor o documento de informe de rendimentos.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

• O cliente de nosso parceiro possua uma conta ativa.

Requisição (Request)

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/income-report?calendar={{2021}}

--request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/income-report?calendar={{2021}}' \  
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'api-version:1.0' \  
--header 'Authorization: Bearer {{accessToken}}' \

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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

📘

Nota

Caso o campo calendar não seja preenchido, será considerado o ano calendário como padrão, que é o ano atual da consulta menos um.

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 completada com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
   "payerSource": {
      "name": "Acesso Soluções de Pagamentos S.A",
      "documentNumber": "13140088000199"
   },
   "holder": {
      "name": "Nísia Floresta",
      "documentNumber": "47742663023"
   },
   "account": {
      "branch": "0001",
      "number": "15164"
   },
   "balances": [
      {
         "year": "2020",
         "amount": 10.45,
         "currency": "BRL"
      },
      {
         "year": "2021",
         "amount": 105.78,
         "currency": "BRL"
      }
   ],
   "netIncome": {
      "amount": 0,
      "currency": "BRL"
   }
}

📘

Nota

Este endpoint possibilita que nossos parceiros estruturem um documento de informe de rendimentos para seus clientes. Se desejarem que os dados se apresentem com o layout do Bankly, recomendamos a utilização do endpoint a seguir.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

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).

Eventos

Este endpoint não possui eventos relacionados a ele.