Integração Bancária API Bradesco Webhook
Este documento apresenta o processo de integração e uso da API do Bradesco, incluindo a configuração do Webhook para notificações em tempo real. A API possibilita a automação de operações bancárias, enquanto o Webhook assegura atualizações imediatas sobre transações e eventos.
Requisitos Importantes
- Para homologar uma carteira API, o recomendado é abrir um novo convênio de conta bancária. Caso opte por utilizar um convênio já em uso no IXC ou que já tenha emitido boletos, esteja ciente de possíveis divergências em relatórios, como:
- Informações de Título não encontrado nos processamentos de retorno (referentes aos títulos da carteira API).
- Liquidações atreladas a boletos divergentes.
- Importante: Após a homologação da carteira API, evite a emissão de novos boletos pela antiga carteira de remessa/retorno que utiliza o mesmo convênio.
Funcionalidades Principais
- Geração automática de boletos.
- Consulta do status de transações.
- Recebimento de notificações em tempo real via Webhook.
- Gerenciamento completo da carteira de cobrança.
Funcionamento No Sistema
A integração com a API Bradesco funciona da seguinte forma:
-
Autenticação:
- O sistema utiliza as credenciais fornecidas pelo Bradesco (Client ID e Client Secret) para autenticação na API.
-
Sincronização de Dados:
- Informações de cobranças geradas no Sistema são enviadas ao Bradesco.
- Atualizações sobre o status de boletos e pagamentos retornam ao Sistema.
-
Processamento Automático:
- Pagamentos são baixados automaticamente, reduzindo atrasos e erros manuais.
-
Interface de Usuário:
- Usuários podem gerenciar boletos e acessar informações diretamente no Sistema.
Processo De Integração e Homologação
O processo de integração e homologação inclui a obtenção de credenciais, a criação da carteira Gateway no Sistema e a configuração de parâmetros bancários.
Pré-requisitos do Cliente Bradesco
Para consumir a API Banco Bradesco em Produção, o cliente deve atender os seguintes requisitos:
- Ser cliente do tipo Pessoa Jurídica.
- Ter contrato de cobrança ativo, com os indicadores
175e182habilitados.- Ter acessado o site Bradesco Net Empresa pelo menos uma vez.
Em caso de dúvidas, entre em contato com seu
Gerente de Cashdo Banco Bradesco.
Homologação
Dados Bancários Necessários Para Integração:
237 - Bradesco (API)
- Número da agência com dígito.
- Número da conta com dígito.
- Número do convênio/beneficiário ou cedente.
- Chave Pix (caso use boleto híbrido — Boleto + Pix).
- Client ID.
- Client secret.
- O convênio bancário é novo ou já foi usado para emissão?
Dica!
Consulte o gerente da sua conta bancária caso tenha dúvidas sobre alguma informação.
Passo a Passo Para Obter Credenciais Da API
Informação!
Credenciais de API
Para homologar a carteira API, você precisa gerar o
Client IDe oClient Secretno portal Developers Bradesco.
Realize este processo com o acompanhamento do suporte financeiro.
Criando a Carteira
- No Sistema, acesse: Menu Sistema > Financeiro > Carteira de cobrança.
- Clique em Novo.
- Na aba Carteira de cobrança, configure:
- Descrição: Nome da carteira.
- Conta: Crie a conta que armazena os dados bancários.
- Tipo de recebimento: Escolha Gateway.
- Enviar e-mail para cliente ao gerar: Marque como Não, evitando envios automáticos de faturas e alterações desnecessárias no registro.
- Validar filial na venda: Marque como Sim.
- Planejamento analítico: Utilize o padrão 240 ou cadastre outro.
- Fim.
Configurações Gateway
- Gateway: Selecione Bradesco.
- Ambiente gateway: Produção.
- Client ID: Insira o código da aplicação API.
- Client secret: Insira a chave da aplicação API.
Novo!
Agora estão disponíveis dois novos campos para o controle do float (como D+0, D+1) da data de crédito.
- Se for preenchido com “0”, a data do crédito será igual à data do pagamento.
- Se for preenchido com “1” ou valor maior, a data do crédito deve ser a data do pagamento + o número de dias úteis do campo.
Campos Adicionados:
- Data de crédito Pix: data em que a movimentação financeira ficará registrada no ato de recebimento.
- Data de crédito boleto: data em que a movimentação financeira ficará registrada no ato de recebimento.
- Número Convênio: Informe o número do convênio (9 dígitos). Complete com zeros à esquerda, se necessário. Exemplo: 000884395.
- Habilitar Pix no boleto: Marque esta opção para utilizar o boleto de cobrança híbrido (também é adicionado o QR code Pix na impressão de boletos).
- Enviar cobrança Pix pelo WhatsApp: Ativa a funcionalidade de envio do Template Cobrança Pix, exclusivo da integração com o Opa! Suite. Habilitando este parâmetro, um novo campo ficará visível e obrigatório:
- Tipo da chave PIX do gateway: Selecione na lista a opção que corresponde ao Tipo da chave PIX do gateway que será utilizada (CPF/CNPJ, E-mail, Telefone ou Chave Aleatória).
- Chave PIX do gateway: Insira a chave Pix principal que está configurada e é utilizada pela sua conta na instituição financeira correspondente a esta carteira de cobrança.
Aviso!
Certifique-se de preencher corretamente o número do convênio para evitar falhas na comunicação.
Juros/Multas/Desconto
- Juros %: Configure 0.033% (máximo permitido por lei).
- Multa %: Configure 2% (máximo permitido por lei).
- Desconto até o vencimento R$: Configure um valor fixo em Reais (opcional).
- Desconto até o vencimento %: Informe o percentual de desconto (opcional).
Para mais informações, veja: Juros, Multas e Desconto.
Instruções
-
Bradesco API: Limite de 200 caracteres por linha de instrução no boleto.
Exemplo de instruções: -
Instrução 1:
Após vencimento juros R$ #juro# ao dia.
- Instrução 2:
Após vencimento multa R$ #multa#.
Para mais informações, veja: Instruções da Carteira de Cobrança.
Impressão
- Layout de impressão: Utilize o padrão 3 por página.
Para mais informações, acesse: Layouts de Impressão.
Logs carteira de cobrança
Aba destinada ao armazenamento dos logs de criação e alteração dos Gateways e APIs.
É importante ressaltar que, mesmo que a autenticação falhe, a carteira de cobrança será salva, e o log detalhado será registrado para posterior investigação.
Dica!
Para mais informações sobre a aba Logs carteira de cobrança, consulte em:
Fluxo De Funcionamento
sequenceDiagram participant S as Sistema participant API as API Bradesco participant W as Webhook S->>API: Envia solicitação (ex: gerar boleto) API->>S: Responde com dados do boleto Note over API,W: Evento ocorre (ex: pagamento) W->>S: Envia notificação do evento S->>API: Confirma o recebimento
Aviso!
Ao salvar a carteira pela primeira vez, o sistema envia uma solicitação para a API Bradesco. O status de retorno deve ser 200 (Sucesso). Caso contrário, revise a comunicação entre o Sistema e a API.
Considerações Finais
A integração com a API Bradesco e a configuração do Webhook facilitam uma gestão financeira mais eficiente e automatizada. Certifique-se de manter as credenciais seguras e atualizadas, garantindo o funcionamento contínuo da integração.
Leia Também
- Carteira de Cobrança
- Integrações Bancárias - Carteira de Cobrança
- Integrações Bancárias - API
- Contas a Receber
- Comunicação com Gateway
- Como Reprocessar Logs Gateway
- Localizar Pagamentos - Logs Gateway
- Logs de Rotinas de Cobrança Gateway
- Troca de Carteira de Cobrança em Massa
- Como Solicitar o Pix na Central do Assinante
- Manual Bradesco API (necessário cadastrar-se para visualizar)
