Informe de rendimentos em PDF
deprecated
Atenção
Este endpoint foi descontinuado. O Parceiro deverá gerar o PDF com sua identidade visual. Para geração de dados para o informe de rendimentos, consulte a documentação disponível na versão 2.
Este endpoint oferece ao nosso parceiro um arquivo pronto para que ele possa disponibilizar aos seus clientes os informes de rendimento de suas contas em formato PDF.
O PDF gerado terá o logo do Bankly.
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/print?calendar={{2021}}
--request GET
--url 'https://api-mtls.sandbox.bankly.com.br/accounts/{{accountNumber}}/income-report/print?calendar={{2021}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'api-version: 2.0' \
--header 'x-bkly-pix-user-id: {{clientDocument}}' \
--header 'Authorization: Bearer {{Token}}' \
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 |
|---|---|
income.report.read | Concede acesso para a leitura do recurso de informe de rendimento. |
Cabeçalhos (Headers)
| Nome | Descrição | Especificação |
|---|---|---|
api-verion | Obrigatório. Versão da API. Utilize este endpoint na versão 2.0. | — |
Authorization | Obrigatório. Token de autorização do tipo Bearer. | — |
x-bkly-pix-user-id | Obrigatório. Número do documento do cliente (CPF ou CNPJ). | Informe apenas números, sem caracteres especiais. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
accountNumber | path | Obrigatório. Número da conta ao qual se deseja obter os dados para o informe. |
calendar | query | Ano para a geração das informações do informe de rendimento. O valor padrão é o ano atual da consulta menos um. |
Nota
Caso o campo
calendarnã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:
| Nome | Tipo | Descrição |
|---|---|---|
fileName | string | Nome do arquivo. |
contentType | string | Tipo de dado que o arquivo contém. |
incomeFile | string | Conteúdo do informe em formato base64. |
{
"fileName": "string",
"contentType": "string",
"incomeFile": "base64string"
}
Nota
Para garantir a segurança dos dados, o arquivo PDF é retornado em formato base64.
Exemplo de informe de rendimentos em PDF
Erros
Este endpoint pode retornar erros específicos, conforme a tabela a seguir:
| Status code | Código | Mensagem | Descrição |
|---|---|---|---|
| 400 | INCOME_REPORT_NOT_AVAILABLE | Income report is not available in the moment, please later try again. | As informações ainda não estão disponíveis para o ano informado. |
| 400 | CALENDAR_NOT_ALLOWED | The calendar informed is not allowed. | Calendário informado não permitido. |
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).
Importante
Caso o campo
calendarse refira ao ano vigente, existe a possibilidade de as informações ainda não estarem disponíveis. Recomendamos aguardar e realizar a consulta após alguns dias.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 3 months ago