Introdução
Esta base de conhecimento tem como objetivo detalhar como é feito o processo de cadastro de uma aplicação para uso da API Pix no portal do Banco do Brasil. Para ter acesso a documentação oficial clique aqui.
Esta funcionalidade está disponivel no MOVERE a partir da versão v4.608.
Processo cadastral
Acesse o site: https://developers.bb.com.br/home
Clique em "Cadastre-se" no canto superior direito.
Será solicitado um CPF para cadastro. Só é possível realizar o cadastro a partir de um CPF.
Na tela seguinte será solicitado o nome completo, nome da mãe e data de nascimento
Na tela seguinte será solicitado um e-mail.
Na tela seguinte será solicitado um número de celular. Será enviado um código para confirmação no celular.
Informe o código recebido no celular
Por fim será solicitado uma senha numérica.
Após finalizado o cadastro, realize o login com as credenciais cadastrada.
Caso seja o primeiro acesso, será exibido um termo de uso do portal, a assinatura é obrigatório e não substitui a assinatura posterior do termo de uso da api quando forem solicitadas as credenciais de produção.
Implantação da Integração
Após realizar o login, você deve criar uma nova aplicação dentro do portal.
Preencha os campos obrigátorios que serão solicitados.
Selecione a contratação da api cobranças. Ela será utilizada para gerar o boleto pix.
Por fim clique em Criar.
Após criada a aplicação, selecione ela.
Será exibida uma barra lateral amarela, você deverá clicar sobre o menu [Produção].
Preencha o CNPJ da empresa que irá utilizar a solução.
O nome da empresa será exibido. Clique em [Próximo].
Verifique se os dados estão corretos e clique em [Solicitar Produção].
Caso você seja o representante da empresa que irá utilizar a aplicação, um termo de uso será exibido para aceitação.
Caso você não seja o representante da empresa, a aplicação ficará aguardando aprovação e será exibida uma notificação na conta do portal do representante da empresa para aceitação do termo.
Após realizado todo o processo corretamente, será necessário acessar as credenciais de produção no menu lateral do portal.
As credenciais devem ser informadas nas configurações de conta financeira no MOVERE.
Para integração com o BB, devem ser informadas as seguintes URL's:
- HOMOLOGAÇÃO:
- API: https://api.hm.bb.com.br/cobrancas/v2
- Autenticação: https://oauth.hm.bb.com.br
- PRODUÇÃO:
- API: https://api.bb.com.br/cobrancas/v2
- Autenticação: https://oauth.bb.com.br
Também será necessário cadastrar o certificado do estabelecimento no Portal Developers BB. Deve ser utilizado o mesmo certificado que foi cadastrado no MOVERE.
Também será necessário cadastrar o parâmetro por estabelecimento [P1322 - Serial key do certificado para geração pix].
Os certificados que já foram importados no MOVERE podem ser encontrados no [Configurador MOVERE]. O parâmetro deve ser cadastrado com o serial de um certificado válido cadastrado para o estabelecimento.
Registrando boletos
Após realizado todo o processo de implantação e configuração da integração, já será possível registrar boletos pix utilizando a [R249]. Para issto, basta acessar a rotina, selecionar o titulo e clicar em [Boleto].
Algumas regras estão definidas para boletos gerados utilizando a integração:
- Caso exista valor de multa no titulo mas a data de multa não esteja preenchida, a data de multa será considerada um dia após a data de vencimento.
- Caso exista valor de desconto no titulo mas a data de limite de desconto não esteja preenchida, a data limite de desconto será considerada igual a data de vencimento.
- Modalidade de cobrança: 1 - Simples
- Aceitar titulo vencido e numero dias limite recebimento: Informação não enviada, deve ser definido no convênio.
- Aceitar recebimento parcial: Não
OBS: Caso já realizado a impressão no momento do faturamento pela R657, não será necessário acessar a R249 para registrar o boleto.
O boleto será exibido com o QrCode e já está pronto para pagamento, dispensando a geração de remessa pela [R215].
Alteração de boletos
Para realizar a alteração de algum titulo que já teve um boleto registrado utilizando a API, será necessário acessar a rotina [R1224 - Boletos Registrados] e realizar a exclusão do boleto.
Esta ação deve ser realizada com muita cautela, pois o boleto será cancelado no sistema do Banco do Brasil, e caso
o pagamento ja tenha sido realizado o valor pago pode ficar perdido, fazendo com que seja necessário entrar em contato com o gerente de relacionamento do banco para resolver.
Baixa do boleto
É possível automatizar a baixa dos boletos no momento que eles são pagos.
Para isto será necessário realizar uma configuração no Portal Developers BB, isso deverá ser feito após a configuração do certificado e envio da aplicação para produção.
Com todas as configurações feitas, o Banco do Brasil enviará solicitações ao MOVERE quando baixa operacional de um boleto for realizada, com isso o [Agente de Tarefas] verificará a partir do dia seguinte ao recebimento da baixa se o boleto foi liquidado e realizará a baixa do titulo.
Acesse o menu [Webhooks] na barra lateral do Portal Developers BB.
Será exibida uma opção para cadastro do evento para receber o webhook em produção.
Selecione a API Cobranças e o convênio que foi cadastrado no MOVERE.
A URL deverá ser HTTPS e deve estar no formato https://SERVIDOR/EMPRESA/api/BoletoPix/RecebimentoBoletos
Exemplo: https://update.moveresoftware.com/stage/api/BoletoPix/RecebimentoBoletos
No MOVERE, será necessário configurar o parâmetro por empresa [P1331 - Usuário para acesso anônimo a APIs] que será utilizado para salvar as informações recebidas, e o parâmetro [P1341 - Dias limite para consulta de retorno pagamento boleto pix banco do brasil] que será utilizado para controlar por quantos dias será realizada a consulta de status do boleto na API do Banco do Brasil após recebimento do sinal de retorno. Este usuário deve ter direito na rotina [R242 - Retorno de Remessa de Cobrança Bancária]. Também será necessário ativar o agente 37 no [Agente de Tarefas].