Sumário:

1. Visão Geral
2. Fluxograma completo de utilização
3. Como obter credenciais junto ao banco
   
   1. Pré-requisitos para realizar o procedimento completo de liberação de credenciais bancárias.
   2. Criação da Aplicação
   3. Acessar Aplicação
   4. Coleta das credenciais
4. Como configurar as credenciais no PlugBoleto
5. Instruções e codigos aceitos no registro via API
   
6. Recursos disponíveis API Santander
   
   1. Boleto Hibrido Santander 
      1. O que é necessário para utilizar o Boleto Hibrido com o banco Santander?
      2. Emitindo o boleto híbrido VIA API
      3. Consultando o boleto híbrido
      4. Impressão do boleto híbrido
   2. Consulta de Boletos
      1. Consulta individual
      2. Consulta geral em boletos REGISTRADOS
      3. Informações sobre Pagamento de Boletos disponível na API Santander V2
   3. Alteração de Boletos
      1. Requisitos para a Alteração de Boletos 
      2. Como ativar a Alteração via API
      3. Como disparar a requisição para realizar a alteração individual via API BANCÁRIA.
      4. Campos disponíveis para alteração 
   4. Baixa de Boletos
      1. Requisitos para a Baixa de Boletos
      2. Como solicitar a Baixa

Visão Geral

O recurso de transmissão instantânea foi desenvolvido para facilitar a integração de sistemas de cobrança com as APIs bancárias, oferecendo uma solução prática e eficiente para desenvolvedores.

Esse método permite a consulta direta dos dados dos boletos nos servidores bancários, retornando imediatamente após sua criação o status REGISTRADO como nos boletos de cobranças de grandes marketplaces.

Ao utilizar a transmissão instantânea, desenvolvedores conseguem implementar um fluxo de emissão de boletos mais ágil e seguro, permitindo que clientes finais possam realizar o pagamento dos títulos logo após a criação. Isso elimina o tempo de espera que existe no tradicional método de transmissão de remessas e obtenção de retorno que é D+1, já que cada boleto emitido pelo sistema é validado instantaneamente, integrando-se com o servidor bancário em tempo real.

Essa solução simplifica a comunicação com instituições financeiras, reduzindo o esforço de implementação e manutenção de sistemas de cobrança, enquanto melhora a experiência do usuário final. Com a transmissão instantânea, é possível construir aplicações financeiras robustas que garantem precisão nos dados de pagamento, ao mesmo tempo em que agilizam o processo de verificação e registro de boletos.

Atenção: Apesar de a captura do status de REGISTRO ou REJEIÇÃO via API ser imediato as LIQUIDAÇÕES(pagamentos) não seguem a mesma dinâmica, dependendo dos procedimentos internos do banco. Isso significa que o status de liquidação não está disponível instantaneamente e depende dos prazos internos de atualização de suas bases. Esse tempo pode variar de acordo com o banco e o serviço de API.

Fluxograma completo de utilização.

Como obter as credenciais junto ao Banco do Brasil

Para começar a utilizar o registro instantâneo com o Banco do Brasil, é preciso apenas possuir um cadastro ativo no portal developer do banco. Este cadastro pode ser feito diretamente no CPF do responsável financeiro cadastrado no banco ou criado um cadastro no CPF de terceiros para gerenciamento e também cadastrado no CPF do responsável financeiro para autorização de uso.

Como habilitar a transmissão instantânea

Para conseguir realizar a habilitação da transmissão instantânea você precisará os seguintes passos, primeiramente será necessário realizar o acesso ao portal developer, com os dados do administrador da conta, e após este passo será feita a aquisição das credenciais, onde serão explicadas logo abaixo.

1 - Dentro do portal do desenvolvedor, será necessário criar uma aplicação e primeiramente criar uma API com a opção Cobrança selecionada, nesse primeiro momento será possível criar apenas a API de testes.

2 - Após a criação da aplicação e também da API, será disponibilizado as credencias para a comunicação com o banco. Para obter as credenciais acesse a aba Credencias dentro do portal do desenvolvedor do Banco do Brasil.

3 - Com as credenciais já é possível configurar o PlugBoleto para realizar os registros via API no Banco do Brasil, para configurar o convenio segui a passo a passo logo a baixo:

Acesse o portal do Plugboleto e na página de convênios na opção Configurações do convênio, você irá encontrar o campo "Registro instantâneo", esse campo é onde você habilita o uso desse recurso no seu convênio, selecione a opção V2 para utilizar a API V2 do Banco do Brasil conforme o exemplo abaixo:

EXEMPLO:

Você também pode realizar o cadastro das informações diretamente utilizando a rota da API via JSON, conforme detalhado na documentação a seguir:

https://atendimento.tecnospeed.com.br/hc/pt-br/articles/360006145374-Cadastrando-um-Conv%C3%AAnio

Abaixo, também segue um JSON de exemplo para demonstrar este cadastro:

{ 
    "ConvenioNumero": "5033", 
    "ConvenioDescricao": "Convenio da tecnospeed", 
    "ConvenioCarteira": "17", 
    "ConvenioEspecie": "R$", 
    "ConvenioPadraoCNAB": "400", 
    "ConvenioApiId":"asbf-vfg5-vf5-cdg4", 
    "ConvenioApiKey": "asbf-vfg5-vf5-cdg4", 
    "ConvenioApiSecret": "asbf-vfg5-vf5-cdg4", 
    "ConvenioRegistroInstantaneo": true, 
    "Conveniotipowebservice": "V2", 
    "ConvenioConsultaws": true, 
    "ConvenioReiniciarDiariamente": true, 
    "conta": 14404 
}

Lembrando que estas credenciais são apenas para demonstração, nenhuma delas é válida para uso em produção.

Credenciais:

Para o preenchimento das credenciais:

API - ID: Informe o client_id disponibilizado pelo banco.

Chave Key: Informar o developer_application_key disponibilizado pelo banco.

Segredo: Informar o client_secret disponibilizado pelo banco.

Instruções para emissão no ambiente de homologação do Banco do Brasil v2

Para emissão no ambiente de homologação v2 do Banco do Brasil, o banco exige que seja enviado CNPJ's e CPF's específicos para testes, essas informações devem ser enviadas nos campos  SacadoCpfCnpj e SacadoNome do Plugboleto. Abaixo está a lista exigida pelo banco:

Por padrão o Plugboleto vai enviar alguns dados que precisam se fixos no ambiente de homologação, esses dados são: