Como funciona
Nossa API de Boletos concentra os endpoints para gestão de liquidação de boletos, possibilitando a consulta de informações direto da Núclea (antiga CIP) até a liquidação de boletos simples e de arrecadação/convênios.
1 - Consulte o boleto na Núclea (GET)
Antes de criar um pagamento para boleto, confirme que o valor a ser pago esteja atualizado com as devidas multas, juros, adicionais ou descontos, consultando este boleto na Núclea. Há um limite de consultas de boletos na Núclea, para mais informações entre em contato com o suporte.
2 - Crie um boleto dentro de um lote (POST)
Para criar um pagamento de boleto, você deve enviar o valor, data de pagamento, número código de barra ou linha digitável, descrição do boleto e o tipo do lote com ”boleto”.
3 - Feche para processar o lote de pagamentos (POST)
Assim que o lote for fechado, iniciamos o processamento de todos os pagamentos daquele lote.
4 - Consultar boleto (GET)
Você pode consultar a qualquer momento o status e detalhes dos boletos. Use o endpoint ”Consultar boleto” e mantenha seus pagamentos atualizados.
Recomendamos considerar sempre os status finais de FINALIZADO e DEVOLVIDO para tomada de ação, FINALIZADO considera sucesso e DEVOLVIDO considera falha no pagamento.
Sobre a devolução pela compensação, o boleto de pagamento recebido em regime de contingência decretado pela Núclea poderá ser devolvido pelo seu valor recebido integralmente pela Instituição Participante Destinatária à Instituição Recebedora, desde que tenha sido recebido nos canais eletrônicos. Para mais informações, consulte os manuais da Núclea (antiga CIP).
Recibos Bancários
Os links dos recibos que estão nos relatórios que geramos, ou que é consultado da nossa API ou e-mail tem uma data de expiração de 60 dias, após isso o link não estará mais disponível por questões de segurança. Para conseguir outro link basta fazer uma nova consulta pela nossa API ou acessar a nossa plataforma.
Boletos vencidos, com juros, multa ou desconto
Antes de criar lotes com boletos vencidos, com juros, multas ou descontos, é necessário consultar as informações detalhadas do boleto usando a nossa API de consulta (veja Consulta de boleto na Núclea). Quando criado um lote com boletos, você precisa fornecer o boleto com o valor incluindo juros, multas e descontos.
- Não é possível agendar boletos vencidos.
- Apenas boletos do tipo SIMPLES podem ser pagos após a data de vencimento. Boletos simples são todos que não são de arrecadação.
- A consulta deve ser realizada no mesmo dia da liquidação.
Convênios aceitos
Somente serão liquidados os boletos de arrecadação contidos nesta listagem. Os demais boletos serão devolvidos.
Updated about 1 year ago