🧪 Nova Experiência: Você está testando nossa nova documentação. Dê sua opinião
erp4me

Configuração do Boleto Express com o Banco do Brasil no Shop

Configurar Boleto Express com Banco do Brasil (BB) no SHOP

Este guia orienta a configuração do recurso de Boleto Express integrado ao Banco do Brasil (BB) no sistema Shop. A implementação permite a emissão e registro imediato de títulos, otimizando a gestão financeira do negócio. Consulte o Detalhamento de Campos para entender o impacto de cada campo no negócio.

Antes de começar

  • Possuir conta corrente ativa no Banco do Brasil.
  • Ter acesso ao Internet Banking e Aplicativo BB (perfil administrador).
  • Possuir o número do Convênio, Carteira e Variação de Carteira fornecidos pelo banco.
  • Estar com o sistema Shop atualizado.

Cadastro na Plataforma Developers BB

Tela de cadastro inicial no Portal Developers BB.

  1. Acesse o Portal Developers BB e clique em Entrar.

  2. Informe o CPF e clique em Avançar.

  3. Preencha o nome completo e a data de nascimento, clicando em Avançar.

  4. Insira um e-mail válido e valide-o com o código de verificação recebido.

  5. Informe um número de celular válido e valide-o com o código recebido via SMS.

  6. Crie uma senha (8 a 16 caracteres, com letras maiúsculas, minúsculas, números e caracteres especiais como @, !, #).

Criação da Aplicação e Credenciais

Nas telas para criação da aplicação e geração das credenciais de teste.

  1. No painel principal, clique em Criar Nova Aplicação.

  2. Defina o nome (ex: Alterdata) e a descrição da aplicação.

  3. Selecione as APIs necessárias: Cobrança (obrigatória) e PIX (opcional).

  4. Clique em Criar.

  5. Acesse Credenciais > Gerar credenciais no ambiente de teste para validação inicial.

Homologação e Produção

Nas telas de envio para produção, dados de contato e status da aplicação:

  1. Dentro da aplicação, clique em Enviar para produção.

ATENÇÃO EXTREMA AO CNPJ: Nunca utilize o CNPJ da Alterdata. É obrigatório indicar o CNPJ da própria empresa do cliente para evitar falhas de validação.

  1. Preencha os dados de contato (e-mail e telefone.), aceite os termos e clique em Enviar.
    O status da aplicação mudará para "Aguardando aprovação".

  2. O cliente deve acessar o Aplicativo BB no celular, ir até a seção de Pendências e aprovar o contrato de uso da API.

  3. Após a aprovação, retorne ao portal, acesse a aplicação e vá em Credenciais > Ambiente de Produção > Gerar Credencial.

  4. Importante: Salve o Client ID, Client Secret e App Key.

Configuração no Sistema Shop

  1. No Shop, acesse o módulo Financeiro > tela de configuração do Boleto Express.

  2. Siga o caminho: Fintech > Banco do Brasil.

  3. Preencha os campos conforme as credenciais obtidas.

📋 Detalhamento de campos — Configuração SHOP

Campo

Onde fica no sistema

Objetivo

Client ID

Fintech > Banco do Brasil

Identificador exclusivo da aplicação gerado no portal do banco.

Client Secret

Fintech > Banco do Brasil

Chave de segurança privada para autenticação da API.

App Key

Fintech > Banco do Brasil

Chave da aplicação necessária para o tráfego de dados.

Convênio

Fintech > Banco do Brasil

Número do contrato de cobrança firmado com o banco.

Carteira

Fintech > Banco do Brasil

Código da modalidade de cobrança (ex: 17).

Variação Carteira

Fintech > Banco do Brasil

Complemento da carteira para identificação do tipo de título.

Nosso Número

Fintech > Banco do Brasil

Sequencial numérico que identifica o boleto de forma única.

Atenção ao prazo de cancelamento: O Banco do Brasil exige um tempo mínimo de 30 minutos após o registro para permitir o cancelamento de um boleto. Tentativas antecipadas gerarão uma mensagem de divergência na integração.

  1. Clique em Confirmar (F9) para gravar as configurações.

Aviso de Ecossistema: Esta rotina integra-se diretamente com o módulo Financeiro do SHOP e depende da estabilidade dos serviços de API do Banco do Brasil.