Cobrança (boletos)
Registrar Boleto
bradesco.registrar_boletoRegistra o boleto, com QR Code Pix (híbrido) ou só com linha digitável
Como usar
Informe vencimento, valor e os dados do pagador (documento, nome e endereço completo: o Bradesco exige). Com QR Code Pix, informe a chave Pix da conta. O resultado em {boleto} traz nosso_numero, linha_digitavel, codigo_barras, qr_code (Pix Copia e Cola) e txid, além da resposta completa do banco. Nosso número vazio: o Bradesco gera.
Exemplo: Para cada venda faturada na planilha, registre o boleto com QR Code e mande {boleto.linha_digitavel} e {boleto.qr_code} por e-mail ao cliente.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Vencimento * | Texto | | Ex.: 25/12/2026 |
| Valor * | Texto | | Ex.: 150,00 |
| CPF ou CNPJ do pagador * | Texto | | |
| Nome do pagador * | Texto | | |
| Logradouro do pagador * | Texto | | |
| Número do endereço * | Texto | | |
| Bairro do pagador * | Texto | | |
| Cidade do pagador * | Texto | | |
| UF do pagador * | Texto | | Ex.: SP |
| CEP do pagador * | Texto | | Ex.: 06029-900 |
| Com QR Code Pix | Sim/Não | Sim | Boleto híbrido: pode ser pago pelo Pix |
| Chave Pix | Texto | | Chave da conta do beneficiário, para o QR Code |
| Variável do resultado | Variável de saída | boleto | |
+ − Avançado (16)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Seu número | Texto | | Seu controle do boleto (até 15 caracteres) |
| Nosso número | Texto | | Vazio: o Bradesco gera |
| Data de emissão | Texto | | Vazio usa hojeEx.: 25/12/2026 |
| Complemento | Texto | | |
| E-mail do pagador | Texto | | |
| Telefone do pagador | Texto | | Com DDD |
| Espécie | Texto | 2 | Código da espécie do título (2 = duplicata mercantil) |
| Juros | Opção | | Opções: Do cadastro, Valor por dia, Percentual ao mês |
| Juros (valor ou percentual) | Texto | | |
| Juros a partir de (dias) | Número | 1 | |
| Multa | Opção | | Opções: Do cadastro, Valor fixo, Percentual |
| Multa (valor ou percentual) | Texto | | |
| Multa a partir de (dias) | Número | 1 | |
| Desconto | Texto | | Valor do desconto até a data limite |
| Data limite do desconto | Texto | | Ex.: 25/12/2026 |
| Campos extras (JSON) | Código | | Campos da API de registro (protesto, negativação, sacador avalista...); completam os do comando |
Resultado: guardado na variável boleto (Dicionário).
Consultar Boleto
bradesco.consultar_boletoSituação e dados do boleto para a segunda via, com o QR Code Pix
Como usar
Informe o nosso número. O resultado em {boleto} traz situacao, linha_digitavel, qr_code (Pix Copia e Cola), qr_code_imagem (PNG em base64), valores, vencimento, pagador e a resposta completa.
Exemplo: Quando o cliente pedir a segunda via pelo atendimento, consulte o boleto e responda com {boleto.linha_digitavel} e {boleto.qr_code}.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Nosso número * | Texto | | Até 11 dígitos, sem o dígito verificador |
| Variável do resultado | Variável de saída | boleto | |
+ − Avançado (1)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Nome no QR Code | Texto | | Vazio usa 'bradesco' |
Resultado: guardado na variável boleto (Dicionário).
Alterar Boleto
bradesco.alterar_boletoAltera vencimento e valor do boleto
Como usar
Informe o nosso número e o que mudar: vencimento, valor ou ambos. Juros, multa, descontos e protesto vão em Campos extras, dentro de dadosTitulo (ex.: {"dadosTitulo": {"valorMulta": 200}}). O módulo consulta o boleto antes e reenvia os dados atuais com a mudança (o Bradesco pede o título inteiro). O resultado em {alteracao} traz o código e a mensagem do Bradesco.
Exemplo: Quando o cliente negociar mais prazo, altere o vencimento do boleto para a nova data combinada.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Nosso número * | Texto | | Até 11 dígitos, sem o dígito verificador |
| Novo vencimento | Texto | | Ex.: 25/12/2026 |
| Novo valor | Texto | | |
| Variável do resultado | Variável de saída | alteracao | |
+ − Avançado (2)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Campos extras (JSON) | Código | | Campos da API de alteração (dadosTitulo: juros, multa, descontos, protesto) |
| txid do boleto | Texto | | Boleto com QR Code: o txid devolvido no registro |
Resultado: guardado na variável alteracao (Dicionário).
Baixar Boleto
bradesco.baixar_boletoPede a baixa do boleto (cancela a cobrança)
Como usar
Informe o nosso número. O resultado em {baixa} traz a situação nova do título em dados.status e a anterior em dados.statusAnterior.
Exemplo: Quando um pedido for cancelado no ERP, baixe o boleto dele para o cliente não pagar por engano.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Nosso número * | Texto | | Até 11 dígitos, sem o dígito verificador |
| Variável do resultado | Variável de saída | baixa | |
+ − Avançado (1)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Código da baixa | Texto | 57 | Motivo da baixa na tabela do Bradesco |
Resultado: guardado na variável baixa (Dicionário).
Listar Boletos Pendentes
bradesco.listar_boletosBoletos em aberto do beneficiário, com filtros de vencimento, registro e pagador
Como usar
Informe, se quiser, os períodos de vencimento e de registro e o pagador. O resultado em {boletos} é uma lista; cada item traz nossoNumero, seuNumero, valTitulo (em centavos), dataVencto, descrStatus e o pagador.
Exemplo: Toda segunda-feira, liste os boletos vencidos na semana anterior e mande a lista para a cobrança.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Vencimento de | Texto | | Ex.: 25/12/2026 |
| Vencimento até | Texto | | Ex.: 25/12/2026 |
| Variável da lista | Variável de saída | boletos | |
+ − Avançado (4)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Registro de | Texto | | Ex.: 25/12/2026 |
| Registro até | Texto | | Ex.: 25/12/2026 |
| CPF ou CNPJ do pagador | Texto | | |
| Buscar todas as páginas | Sim/Não | Sim | |
Resultado: guardado na variável boletos (Lista).
Listar Boletos Liquidados
bradesco.listar_boletos_liquidadosBoletos pagos no período, inclusive pelo QR Code Pix
Como usar
Informe o período de pagamento (ou de movimento). O resultado em {liquidados} é uma lista com nossoNumero, seuNumero, valorPagamento (em centavos), dataPagamento, nomePagador e indicadorPagoQrCode (S quando pago pelo Pix).
Exemplo: Todo dia, liste os boletos pagos ontem e dê baixa nos títulos correspondentes no ERP.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Pagamento de | Texto | | Ex.: 25/12/2026 |
| Pagamento até | Texto | | Ex.: 25/12/2026 |
| Variável da lista | Variável de saída | liquidados | |
+ − Avançado (3)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Movimento de | Texto | | Ex.: 25/12/2026 |
| Movimento até | Texto | | Ex.: 25/12/2026 |
| Buscar todas as páginas | Sim/Não | Sim | |
Resultado: guardado na variável liquidados (Lista).
Pagamentos e Pix
Validar Boleto
bradesco.validar_boletoLê um boleto a pagar: beneficiário, vencimento e valores calculados
Como usar
Informe o código de barras ou a linha digitável de um boleto de qualquer banco. O resultado em {titulo} traz nmCedente (beneficiário), dataVencimento, valorTitulo, valorCobrado (com juros, multa e desconto), valorMin/valorMax e codBarras.
Exemplo: Antes de pagar os boletos de fornecedores, valide cada um e confira se o beneficiário bate com o cadastro.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Código de barras ou linha digitável * | Texto | | 44 ou 47 dígitos; pontos e espaços são ignorados |
| Variável do resultado | Variável de saída | titulo | |
Resultado: guardado na variável titulo (Dicionário).
Pagar Boleto
bradesco.pagar_boletoPaga ou agenda um boleto de qualquer banco, debitando a conta da conexão
Como usar
Informe o código de barras ou a linha digitável; o módulo valida o boleto antes. Valor vazio paga o valor calculado pelo banco; data futura agenda o pagamento. O resultado em {pagamento} traz protocolo e id_transacao (guarde um deles para consultar ou cancelar), a situação e o comprovante do banco.
Exemplo: Para cada boleto aprovado na planilha de contas a pagar, agende o pagamento para o vencimento e grave {pagamento.protocolo} na planilha.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Código de barras ou linha digitável * | Texto | | 44 ou 47 dígitos; pontos e espaços são ignorados |
| Valor | Texto | | Vazio paga o valor cobrado |
| Data do pagamento | Texto | | Vazio paga hoje; data futura agendaEx.: 25/12/2026 |
| Variável do resultado | Variável de saída | pagamento | |
+ − Avançado (2)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Id da transação | Texto | | Seu número para o pagamento (até 9 dígitos); vazio gera um |
| Texto no extrato | Texto | | Até 32 caracteres |
Resultado: guardado na variável pagamento (Dicionário).
Consultar Pagamento de Boleto
bradesco.consultar_pagamento_boletoSituação de um pagamento de boleto, pelo protocolo ou pelo id da transação
Como usar
Informe a data do pagamento e o protocolo ou o id da transação. O resultado em {pagamento} traz situacaoPagamento, valorPagamento, dataVencimento, o beneficiário e o motivo, se não foi efetivado.
Exemplo: No dia seguinte ao vencimento, consulte cada pagamento agendado e avise o financeiro dos que não foram efetivados.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Data do pagamento * | Texto | | Ex.: 25/12/2026 |
| Protocolo | Texto | | |
| Id da transação | Texto | | |
| Variável do resultado | Variável de saída | pagamento | |
Resultado: guardado na variável pagamento (Dicionário).
Listar Pagamentos de Boleto
bradesco.listar_pagamentos_boletoPagamentos e agendamentos de boletos da conta no período
Como usar
Informe o período e a situação. O resultado em {pagamentos} é uma lista com protocoloPagamento, dataPagamento, dataVencimento, valorInformado, valorCalculado, bancoEmissor e o motivo de não efetivação.
Exemplo: No fim do mês, liste os pagamentos agendados do próximo mês e monte a previsão de caixa.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Data inicial * | Texto | | Ex.: 25/12/2026 |
| Data final | Texto | | Ex.: 25/12/2026 |
| Situação | Texto | 1 | 1 agendado; o Bradesco aceita 1, 2, 3, 7, 8, 9, 11 e 12 |
| Variável da lista | Variável de saída | pagamentos | |
+ − Avançado (1)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Buscar todas as páginas | Sim/Não | Sim | |
Resultado: guardado na variável pagamentos (Lista).
Cancelar Agendamento de Boleto
bradesco.cancelar_agendamento_boletoCancela um pagamento de boleto agendado
Como usar
Informe o protocolo ou o id da transação do agendamento. O resultado em {cancelamento} traz a mensagem do Bradesco (ex.: CANCELAMENTO EFETUADO).
Exemplo: Quando um fornecedor pedir para não pagar um boleto já agendado, cancele o agendamento pelo protocolo gravado na planilha.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Protocolo | Texto | | |
| Id da transação | Texto | | |
| Variável do resultado | Variável de saída | cancelamento | |
Resultado: guardado na variável cancelamento (Dicionário).
Listar Pagamentos Devolvidos
bradesco.listar_pagamentos_devolvidosPagamentos de boleto devolvidos (não efetivados), com o motivo
Como usar
Informe, se quiser, o período de devolução. O resultado em {devolvidos} é uma lista com protocoloPagamento, linhaDigitavelTituloCobranca, valorInformado e descricaoMotivoNaoEfetivacao.
Exemplo: Todo dia, liste os pagamentos devolvidos e reabra as contas a pagar correspondentes.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Data inicial | Texto | | Ex.: 25/12/2026 |
| Data final | Texto | | Ex.: 25/12/2026 |
| Variável da lista | Variável de saída | devolvidos | |
+ − Avançado (1)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Buscar todas as páginas | Sim/Não | Sim | |
Resultado: guardado na variável devolvidos (Lista).
Consultar Limites de Pagamento
bradesco.consultar_limites_pagamentoLimites e horários de pagamento de boletos da conta
Como usar
O resultado em {limites} traz os limites disponíveis no Bradesco e em outros bancos (limDispTotalBrad, limDispTotalOutr...) e os horários de início e fim (horaInicio, horaFim).
Exemplo: Antes de pagar um lote de boletos, confira se o total cabe no limite disponível do dia.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Variável do resultado | Variável de saída | limites | |
Resultado: guardado na variável limites (Dicionário).
Transferir por Pix
bradesco.transferir_pixPix da conta da conexão, por chave ou por agência e conta
Como usar
Informe o valor, o nome do recebedor e a chave Pix (o tipo é deduzido, ou escolha). Com o CPF/CNPJ do recebedor, o Bradesco confere se a chave é dele. Sem chave, use agência e conta (tipo AGENCIACONTA) com banco e ISPB. O resultado em {pix} traz status (CONCLUIDO, EM_PROCESSAMENTO ou REJEITADO), e2e e id_transacao.
Exemplo: Para cada reembolso aprovado, transfira por Pix para a chave do colaborador e, se o status for EM_PROCESSAMENTO, consulte a transferência depois.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Valor * | Texto | | Ex.: 150,00 |
| Nome do recebedor * | Texto | | |
| Chave Pix | Texto | | |
| CPF ou CNPJ do recebedor | Texto | | Com ele, o banco confere se a chave é do recebedor |
| Variável do resultado | Variável de saída | pix | |
+ − Avançado (8)
| Campo | Tipo | Padrão | Detalhes |
|---|
| Tipo de chave | Opção | | Opções: Deduzir, E-mail, Telefone, CPF/CNPJ, Aleatória, Agência e conta |
| Banco do recebedor | Texto | | Só para agência e contaEx.: 237 |
| ISPB do banco | Texto | | Só para agência e contaEx.: 60746948 |
| Agência do recebedor | Texto | | |
| Conta do recebedor | Texto | | Com o dígito |
| Tipo de conta do recebedor | Opção | Corrente | Opções: Corrente, Poupança, Salário, Pagamento |
| Descrição | Texto | | Até 30 caracteres |
| Id da transação | Texto | | Até 35 caracteres, não pode repetir; vazio gera um |
Resultado: guardado na variável pix (Dicionário).
Consultar Transferência Pix
bradesco.consultar_transferencia_pixSituação de uma transferência Pix
Como usar
Informe o id da transação (e, se tiver, o e2e). O resultado em {pix} traz status (CONCLUIDO, EM_PROCESSAMENTO ou REJEITADO), motivo, valor, recebedor e datas.
Exemplo: Depois de um Pix em processamento, espere alguns segundos e consulte a transferência até ela sair de EM_PROCESSAMENTO.
Campos
| Campo | Tipo | Padrão | Detalhes |
|---|
| Conexão * | Variável | bradesco | |
| Id da transação * | Texto | | |
| E2E | Texto | | |
| Variável do resultado | Variável de saída | pix | |
Resultado: guardado na variável pix (Dicionário).