Informe de Rendimento

Este endpoint permite obter os dados necessários para gerar informes de rendimentos das contas.

Pré-requisitos

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

O cliente do parceiro possua uma conta ativa.
O parceiro esteja autenticado.

Requisição (Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/AccountsInternal/income-report/{{loginAccountNumber}}?year=2025

--request GET 'https://sandbox.hiperbanco.com.br/AccountsInternal/income-report/{{loginAccountNumber}}?year=2025' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/pdf' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

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

Nome	Tipo	Descrição	Especificação
`loginAccountNumber`	`path`	Obrigatório. Número da conta logada.	Use somente numeros.
`year`	`query`	Obrigatório Ano base do informe de rendimentos.	Formato YYYY

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 retornará o arquivo no formato PDF.

Erros

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

Status Code	Código	Mensagem	Descrição
`404`	`ACCOUNT_NOT_FOUND`	Account not found with number...	Conta não encontrada.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.