Comprovantes de Averbação e Cancelamento
Esta seção descreve os serviços disponíveis para obtenção e impressão dos comprovantes de averbação e cancelamento das operações de crédito consignado. Ambos os documentos são gerados automaticamente após o recebimento, pelo sistema BMP, do código de averbação ou cancelamento retornado pela DATAPREV.O sistema aguarda o retorno da DATAPREV para iniciar a geração do documento, que passa a ficar disponível em poucos segundos após a confirmação da operação. Os comprovantes podem ser acessados:
- Via API, conforme os endpoints descritos abaixo; ou
- Pelo Portal Partner, na aba Documentos da proposta.
Disponibilidade:
Os documentos ficam disponíveis para consulta via API por um período de 90 (noventa) dias.
Conteúdo do Documento
Os comprovantes de averbação e cancelamento possuem a seguinte estrutura de informações:Comprovante de Averbação
Endpoint
GET/contrato/comprovante-averbacao
Parâmetros
Exemplo de Requisição
Exemplo de Requisição
Exemplo de retorno
Exemplo de retorno
Comprovante de Cancelamento
Endpoint
GET/contrato/comprovante-cancelamento
Parâmetros
Exemplo de Requisição
Exemplo de Requisição
Exemplo de retorno
Exemplo de retorno
Considerações Técnicas
- Os comprovantes são gerados somente após a confirmação da averbação ou cancelamento pela DATAPREV;
- O campo
ConteudoBase64contém o arquivo do comprovante em formato PDF, codificado em Base64; - É responsabilidade do parceiro realizar a decodificação e armazenamento, se necessário;
- Após o período de 90 dias, os documentos não estarão mais disponíveis via API.

