Esse manual tem como objetivo orientar sobre a configuração da forma de cobrança para emissão de boletos bancários através do Banco Bradesco.
No Bradesco é possível transmitir os boletos para o banco através:
A liquidação dos títulos pode ser realizada através:
Todo o procedimento realizado aqui pode ser acompanhado pela equipe da HubSoft para garantir uma melhor configuração. Em caso de dúvidas, basta acionar nosso time.
Obs: Não edite nenhuma forma de cobrança já existente em sua base. Para realizar uma nova Homologação, é sempre necessário criar uma nova forma de cobrança.
Para configurar a forma de cobrança, será necessário ter os seguintes dados em mãos (solicite esses dados ao seu gerente bancário):
| Dado | Observação |
|---|---|
| Tipo/Formato do CNAB | 400 ou 240 |
| Número do Convênio | |
| Agência | |
| Dígito da Agência (DV) | |
| Conta | |
| Dígito da Conta (DV) | |
| Carteira | Ex: 1, etc. |
| Variação da Carteira | Caso não possua, basta manter em branco |
| Modalidade da Carteira | Caso não possua, basta preencher «Nenhum» |
Outros dados que já é bom ter anotados para facilitar a sua configuração:
Razão Social e CNPJ)Normalmente será a Razão Social da Empresa)Normalmente será: Pago em Qualquer Banco mesmo após o Vencimento)Vá até o HubSoft, no menu lateral Configuração > Financeiro > Forma de Cobrança, conforme imagem abaixo:
Na tela que abrir, clique no canto superior direito em Adicionar para criar uma nova Forma de Cobrança.
Na aba Dados serão preenchidos os dados de Banco Emissão, Caixa Financeiro, Layouts de Impressão, Empresa e Perfil de Suspensão, conforme imagem abaixo. Defina também um bom nome para a sua forma de cobrança — isso facilita o trabalho da sua equipe no momento de realizar uma nova venda.
Preencha o Banco = 237 - BANCO BRADESCO S/A
Na aba Configuração, preenchemos os dados que o gerente bancário passou e também os demais dados como juros, multa, instruções do boleto, espécie do documento, etc.
Preenchidos todos os dados, clique em Salvar e sua forma de cobrança estará configurada.
Importante: o passo a passo acima cobre os campos essenciais e básicos da forma de cobrança. O HubSoft possui diversas outras configurações — para saber mais sobre elas, clique no ícone de interrogação (?) que fica na frente de cada campo, dentro da tela de configuração da forma de cobrança.
A homologação garante que seu provedor consiga se comunicar com o banco através dos arquivos CNAB de Remessa/Retorno. Recomendamos o seguinte procedimento:
Gerar 3 boletos bancários (sugestão: valores de R$ 10,00).
→ Gerar Boleto Bancário
Gerar uma Remessa com os boletos gerados e encaminhar ao banco.
→ Gerar Remessa Bancária
Efetuar o pagamento dos boletos de teste, para garantir que foram gerados corretamente.
Processar o Retorno no dia útil seguinte, quando o banco disponibiliza o arquivo com os pagamentos do dia.
→ Processar Retorno
Após o processamento do Retorno e o reconhecimento do pagamento de pelo menos um boleto de teste, sua Forma de Cobrança estará homologada com sucesso.
O HubSoft possui, em suas rotinas, o envio automático da cobrança ao cliente através dos canais:
Para configurar cada um deles:
Com o Bradesco é possível realizar a transmissão dos boletos para o banco via API. Nessa modalidade, não é necessário gerar e enviar o arquivo de remessa ao banco nem processar o arquivo de retorno no sistema — todo o processo é automático. Ao integrar com a API V2, o provedor envia automaticamente ao banco o registro, as alterações de vencimento e a baixa (cancelamentos/pagamentos) dos boletos, além do retorno (compensação).
Os boletos nessa modalidade são registrados em até 5 minutos no banco após serem gerados.
Caso seja gerado um volume muito grande de boletos (como em um faturamento mensal e/ou de carnês), o registro pode demorar mais que 5 minutos, pois o HubSoft envia os boletos em lotes ao Bradesco.
O primeiro passo é cadastrar seu Certificado Digital no sistema, pois será necessário enviar a chave pública do certificado para solicitar o uso da API V2.
Vá em Configuração > Geral > Certificado Digital:
Clique em Adicionar, selecione o arquivo, digite a senha do certificado e clique em Salvar:
Obs.: se o certificado digital da empresa já estiver configurado no sistema, basta ignorar essa etapa.
Após cadastrá-lo, clique em Ações > Baixar Chave Pública:
Com a chave em mãos, entre em contato com o gerente do banco e solicite a habilitação da funcionalidade 175 - Registro via Webservice.
Exemplo de como solicitar a habilitação e os parâmetros necessários:
Após receber os dados do banco, configure a forma de cobrança.
Com o certificado cadastrado e os dados em mãos, acesse Configuração > Financeiro > Forma de Cobrança, identifique a forma de cobrança desejada e clique em Ações > Editar.
Vá até a aba API e habilite as chaves conforme as ações que deverão ser realizadas pela API:
Muito importante: se o campo Dias Antes de Vencer Para Transmitir via API não for preenchido, o HubSoft transmitirá todos os boletos pendentes via API. Se o seu provedor trabalha com alguma regra específica — por exemplo, registrar somente os boletos que vencem nos próximos 30, 45 ou 60 dias — configure esse campo com exatidão, para evitar custos desnecessários com baixas/cancelamentos de boletos.
Na aba Parâmetros Extras, inclua os parâmetros obrigatórios:
| Parâmetro | Descrição |
|---|---|
versao |
Obrigatório. Utilizar v2 |
client_id |
Obrigatório. Gerado no painel Developer do Bradesco |
client_secret |
Obrigatório. Gerado no painel Developer do Bradesco |
Na aba Certificado, vincule o certificado cadastrado anteriormente:
Após vinculado, será exibido desta forma:
Sucesso! Basta clicar em Salvar e a integração com a API V2 do Bradesco estará pronta. Para validar, gere um boleto de teste nessa forma de cobrança e aguarde a transmissão (até 5 minutos).
A API V2 do Bradesco não possui retorno de pagamentos via callback — os pagamentos são reconhecidos pela rotina de verificação de boletos na API Bancária. Lembre-se de cadastrá-la para que os boletos sejam compensados.
Ao utilizar o Boleto Híbrido, é gerado automaticamente, para cada boleto registrado, um QR Code PIX. Isso traz agilidade ao processo, já que o Bradesco consegue baixar o boleto automaticamente sempre que o PIX correspondente for pago.
Para ativar: Configuração > Financeiro > Forma de Cobrança, na forma de cobrança do Bradesco desejada, clique em Ações > Editar > Parâmetros Extras, adicione o parâmetro pix com valor true e clique em Salvar.
Para receber os webhooks, é necessário cadastrar a URL da API no banco. Siga os passos abaixo:
Identifique a URL da API. Vá até a aba API da forma de cobrança e copie a URL exibida ali:
Acesse o cadastro de webhook. Na listagem de formas de cobrança, identifique a que você está ajustando e clique em Ações > Webhook:
Cadastre a URL. Clique em Adicionar novo Webhook, cole a URL copiada no passo 1 e clique em Salvar:
Atenção: para o webhook do Bradesco funcionar, existe uma particularidade — é necessário possuir um certificado SSL próprio no servidor, autorizando o callback a entrar no servidor. Somente após possuir esse certificado SSL e enviá-lo ao banco, o webhook será efetivamente ativado.
O cliente precisa enviar o certificado público do tipo SSL, em anexo, para o e-mail governancaapis@bradesco.com.br, para cadastro no ambiente produtivo.
Obs.: deve ser enviada a chave pública desse certificado SSL — essa chave não é a mesma do seu certificado A1. Para obter esse certificado SSL, entre em contato com o suporte.
No boleto híbrido, o retorno do pagamento pode acontecer pela rotina de verificação de boletos na API Bancária ou por webhook. Ou seja, mesmo que o cliente pague pelo QR Code PIX, a baixa no sistema só ocorre quando a rotina de verificação executar ou quando o webhook de pagamento for recebido.
Importante: mesmo utilizando webhook, recomendamos manter ativa em seu sistema a rotina de verificação de cobrança de boleto via API. Assim, caso algum webhook não chegue, o sistema consulta os pagamentos e realiza a baixa normalmente.
Basta clicar em Salvar e a ativação do Boleto Híbrido API + PIX do Bradesco estará pronta. Para validar, gere um boleto de teste e aguarde a transmissão (até 5 minutos).
Com o Bradesco é possível realizar a transmissão dos boletos para o banco via API. Nessa modalidade, não é necessário gerar e enviar o arquivo de remessa ao banco — o processo é automático. Ao integrar com a API V1, o provedor envia automaticamente ao banco o registro, as alterações de vencimento e a baixa (cancelamentos/pagamentos) dos boletos, além do retorno (compensação).
Os boletos nessa modalidade são registrados em até 5 minutos no banco após serem gerados.
Caso seja gerado um volume muito grande de boletos (como em um faturamento mensal e/ou de carnês), o registro pode demorar mais que 5 minutos, pois o HubSoft envia os boletos em lotes ao Bradesco.
O primeiro passo é cadastrar o Certificado Digital no sistema e vincular a chave pública, da mesma forma descrita em API (V2) > Adicionando o Certificado Digital no sistema.
Com a chave em mãos, entre em contato com o gerente do banco e solicite a habilitação da funcionalidade 175 - Registro via Webservice.
Exemplo de como solicitar a habilitação e os parâmetros necessários:
Com o certificado cadastrado e os dados em mãos, acesse Configuração > Financeiro > Forma de Cobrança, identifique a forma de cobrança desejada e clique em Ações > Editar.
Vá até a aba API e habilite as chaves conforme as ações que deverão ser realizadas pela API:
Muito importante: se o campo Dias Antes de Vencer Para Transmitir via API não for preenchido, o HubSoft transmitirá todos os boletos pendentes via API. Configure com exatidão caso seu provedor siga uma regra específica de prazo, para evitar custos desnecessários com baixas/cancelamentos.
Na aba Parâmetros Extras, inclua os parâmetros obrigatórios:
| Parâmetro | Descrição |
|---|---|
versao |
Obrigatório. Utilizar v1 |
client_key |
Obrigatório. Gerado/disponibilizado pelo Bradesco |
Na aba Certificado, vincule o certificado cadastrado:
Após vinculado, será exibido desta forma:
Sucesso! Basta clicar em Salvar e a integração com a API V1 do Bradesco estará pronta. Para validar, gere um boleto de teste e aguarde a transmissão (até 5 minutos).
O retorno do pagamento é feito pela rotina de verificação de boletos na API Bancária. Lembre-se de cadastrá-la para que os boletos sejam compensados.
Com o Bradesco é possível realizar o envio/transmissão do boleto para o banco via API. Nessa modalidade, não é mais necessário fazer o envio de remessa para registro do boleto. Os boletos são registrados em até 5 minutos no banco após serem gerados.
Caso seja gerado um volume muito grande de boletos (como em um faturamento mensal e/ou de carnês), o registro pode demorar mais que 5 minutos, pois o HubSoft envia os boletos em lotes ao Bradesco.
A API V0 possui apenas o registro automático de boletos.
Solicite ao gerente do banco a liberação da modalidade Registro On-line de Boletos de Cobrança Bradesco. Após a liberação, cadastre o Certificado Digital no sistema — da mesma forma descrita em API (V2) > Adicionando o Certificado Digital no sistema — e vincule-o à forma de cobrança.
Acesse Configuração > Financeiro > Forma de Cobrança, identifique a forma de cobrança desejada e clique em Ações > Editar.
Vá até a aba API e habilite a chave Transmitir/Registrar via API:
Muito importante: se o campo Dias Antes de Vencer Para Transmitir via API não for preenchido, o HubSoft transmitirá todos os boletos pendentes via API. Configure com exatidão caso seu provedor siga uma regra específica de prazo, para evitar custos desnecessários com baixas/cancelamentos.
Na aba Certificado, vincule o certificado cadastrado:
Após vinculado, será exibido desta forma:
Sucesso! A integração já está funcional. Basta emitir um boleto no HubSoft e verificar se, em até 5 minutos, ele foi registrado.
Para realizar a integração nativa do PIX, solicite ao seu gerente a liberação do PIX COBV para o seu provedor e colete os seguintes dados:
| Parâmetro | Descrição |
|---|---|
client_id |
Fornecido pelo Bradesco |
client_secret |
Fornecido pelo Bradesco |
chave_pix |
Chave PIX fornecida pelo Bradesco (recomendamos chave aleatória) |
certificado |
Chave pública (PEM) do certificado digital e a chave privada |
nome_recebedor |
Nome do provedor |
ambiente |
producao |
Para configurar, vá em Configuração > Integrações > PIX:
Preencha os parâmetros obrigatórios e o Caixa Financeiro onde os PIX serão recebidos:
Assim que os Parâmetros Necessários, o Caixa Financeiro e o Tipo de Movimento Financeiro forem preenchidos, você já pode salvar.
Após configurar a integração, vá em Configuração > Financeiro > Forma de Cobrança, edite a forma de cobrança desejada, acesse a aba Configuração e selecione a integração PIX correspondente.
Assim que esse procedimento for feito, o sistema transmitirá automaticamente todos os boletos em aberto para o PIX. Execute essa etapa com cautela.
Assim que a integração estiver vinculada à forma de cobrança, você já pode salvar.
Quando um PIX é transmitido na fatura do cliente, é possível visualizar as informações dele em Fatura do Cliente > Ações > Visualizar.
Nesse campo também é possível ver o texto PIX Copia e Cola — se enviado ao cliente, funciona como um código de barras/linha digitável do PIX, ou seja, o cliente pode copiá-lo e colar no app do banco para efetuar o pagamento.
Na impressão do boleto também consta o QR Code, para que o cliente pague usando a câmera do app do banco.
Obs.: para layouts personalizados, também é possível incluir o QR Code do PIX.
Abaixo estão listadas algumas perguntas/problemas frequentes relacionados ao Bradesco. Caso alguma dessas situações aconteça e você tenha dificuldade para resolver, não hesite em chamar nosso suporte — estamos aqui para ajudar.
Quais funcionalidades a API Bradesco possui?
Atualmente, a API do Bradesco possui apenas o registro bancário disponível via API.
Por que o boleto do cliente não registrou via API?
Esse tipo de erro costuma ser muito específico — relacionado a algum dado do cliente ou à comunicação entre o sistema e a API bancária. Recomendamos contatar nossa equipe de suporte para investigarmos a causa da melhor forma possível.
