Itaú Boletos

Manage your Itaú bank slips (Boletos).

Authentication

This connector uses Token-based authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use

Using the Smart Chat

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions

This connector provides 26 actions:

Action	Purpose	Parameters
boletos_consulta/get_boletos	Consulta lista de boletos por critérios específicos.	x-itau-flowid (string) id_beneficiario (string) codigo_carteira (string) required nosso_numero (string) required view (string)
boletos_emissao/post_boletos	Emissão ou simulação de boletos registrados na CIP	x-itau-correlationID (string) data: { . id_boleto (string) . etapa_processo_boleto (string) . codigo_canal_operacao (string) . beneficiario . dado_boleto . acoes_permitidas } (object) required
boletos_emissao/get_boletos	Consulta lista de boletos por critérios específicos.	id_beneficiario (string) required codigo_carteira (string) nosso_numero (string) data_inclusao (string) view (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_abatimento	API responsável por efetuar a inclusão/alteração de abatimento para um boleto. O processo de abatimento consiste na diminuição concedida do valor do boleto no momento de recebimento para o cliente. Geralmente, o abatimento é usado quando certas condições estipuladas são encontradas pelo comprador, o que reduz o custo. A quantidade descontada é uma abonação determinada pela quantidade ou valor da compra.	id_boleto (string) x-itau-correlationID (string) data: { . valor_abatimento (string) . codigo (string) . mensagem (string) . campos (array) } (object) required
boletos_emissao/patch_boletos_by_id_boleto_baixa	API responsável por efetuar a baixa de um boleto. O processo de baixa consiste na ação de invalidar o boleto.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_data_vencimento	API responsável por efetuar a alteração da data de vencimento de um boleto. A data de vencimento consiste no último dia para pagamento do boleto sem acréscimo de multa, juros e outros.	id_boleto (string) x-itau-correlationID (string) data: { . data_vencimento (string) . codigo (string) . mensagem (string) . campos (array) } (object) required
boletos_emissao/patch_boletos_by_id_boleto_juros	API responsável por efetuar a inclusão/alteração de juros de um boleto. Juros é uma cobrança que leva em consideração o tempo de atraso no recebimento do boleto com relação a data de vencimento. Os juros agem como uma penalidade para cada dia de inadimplência.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_multa	API responsável por efetuar a inclusão/alteração de multa de um boleto. Multa é uma cobrança referente ao recebimento do boleto em atraso em relação a data de vencimento. A multa é cobrada independente do tenpo de atraso que o boleto se encontra.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_valor_nominal	API responsável por efetuar a alteração do valor nominal do boleto. O valor nominal do boleto consiste no valor integral do boleto, informado pelo cliente, sem adição de outros encargos.	id_boleto (string) x-itau-correlationID (string) data: { . valor_titulo (string) . codigo (string) . mensagem (string) . campos (array) } (object) required
boletos_emissao/patch_boletos_by_id_boleto_data_limite_pagamento	API responsável por efetuar a alteração da data limite de pagamento de um boleto. A data limite de pagamento para pagamento do boleto. Boleto não poderá ser pago após esta data.	id_boleto (string) x-itau-correlationID (string) data: { . data_limite_pagamento (string) } (object) required
boletos_emissao/patch_boletos_by_id_boleto_seu_numero	API responsável por efetuar a inclusão/alteração do seu numero do boleto. Seu número é a identificação do boleto que poderá ter letras e números, utilizado para facilitar a consulta e acompanhamento do status do boleto. Este campo é para controle do cliente.	id_boleto (string) x-itau-correlationID (string) data: { . texto_seu_numero (string) } (object) required
boletos_emissao/patch_boletos_by_id_boleto_protesto	API responsável por efetuar a inclusão/alteração de protesto do boleto. O protesto é a ação através da qual o portador de um título comercial cujo pagamento não foi efetuado dentro do prazo, garante seu pagamento por ações judiciais.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_negativacao	API responsável por efetuar a inclusão/alteração de negativação do boleto. A negativação é o ato de inserir uma pessoa em cadastros de maus pagadores, tais como Serasa e o Serviço Central de Proteção ao Crédito SCPC, porque não pagou uma conta, uma prestação ou outra obrigação financeira.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_desconto	API responsável por efetuar a inclusão/alteração de desconto do boleto, possibilitando oferecer descontos para pagamentos antecipados do boleto.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_pagador	API responsável por efetuar a alteração de dados do Pagador do boleto. O Pagador é a pessoa ou a empresa que deve pagar o valor cobrado em um boleto bancário, normalmente por ter feito uma compra, um financiamento ou por estar pagando por um serviço.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_sacador_avalista	API responsável por efetuar a alteração de dados do Sacador Avalista O Sacador Avalista é o cedente original do título que realizou a transação.	id_boleto (string) x-itau-correlationID (string)
boletos_emissao/patch_boletos_by_id_boleto_recebimento_divergente	API responsável por efetuar a alteração de dados de Recebimento Divergente do boleto, ou seja, os parâmetros de configuração de aceite de recebimento divergente do valor do boleto. Estes dados são configuráveis pelo beneficiário.	id_boleto (string) x-itau-correlationID (string)
boletos_v3/get_francesas	Pesquisa das francesas disponíveis por Agência, Conta Corrente e Mês de Referência ou Data.	x-itau-correlationID (string) required agencia (string) required conta (string) required dac (string) required mes_referencia (string)
boletos_v3/get_francesas_by_id_francesa_movimentacoes	Lista de movimentações efetuadas na posição da francesa.	id_francesa (number) x-itau-correlationID (string) required data (string) required tipo_cobranca (string) tipo_movimentacao (string) nosso_numero (string) seu_numero (string) numero_carteira (number) nome_pagador (string)
boletos_v3/get_francesas_by_id_francesa_movimentacoes_resumidas	Posição da francesa resumida de títulos de cobrança e títulos descontados.	id_francesa (number) x-itau-correlationID (string) required data (string) required
boletos_v3/get_boletos	Consulta lista de boletos por critérios específicos.	x-itau-correlationID (string) required x-itau-flowid (string) codigo_carteira (string) data_inicial (string) required data_final (string) required id_beneficiario (string) required nome_pagador (string) numero_cpf_cnpj_pagador (number) numero_nosso_numero (number) seu_numero (string) situacao_geral_boleto (string) situacao_negativacao (string) situacao_protesto (string) status_vencimento (string) tipo_boleto (string) tipo_data (string) required page (integer) page_size (integer)
boletos_v3/post_notificacoes_boletos	Este endpoint tem como objetivo realizar o cadastro da url, credenciais e preferências para notificações das movimentações de baixa operacional e/ou liquidação dos boletos. Abaixo estão listados os parâmetros obrigatórios exigidos e a descrição deles. O cadastro pode ser realizado para baixa operacional e/ou efetiva liquidação. br/br bImportante:/b Para obter mais informações sobre x-itau-apikey e o x-itau-correlationID, acesse o tópico: Como começar - Autenticação em Produção - Fluxos de aute	x-itau-correlationID (string) required data: { . webhook_url (string) . webhook_oauth_url (string) . webhook_oauth_scope (string) . valor_minimo (number) } (object) required
boletos_v3/get_notificacoes_boletos	Retorna uma lista de notificações que foram cadastradas.	x-itau-correlationID (string) required id_beneficiario (string) required
boletos_v3/delete_notificacoes_boletos_by_id_notificacao_boleto	Exclui uma notificação que está cadastrada.	id_notificacao_boleto (string) x-itau-correlationID (string) required
boletos_v3/patch_notificacoes_boletos_by_id_notificacao_boleto	Atualiza uma notificação que está cadastrada.	id_notificacao_boleto (string) x-itau-correlationID (string) required data: { . webhook_url (string) . webhook_oauth_url (string) . webhook_oauth_scope (string) . valor_minimo (number) } (object) required
boletos/get_boletos	Endpoint responsável por listar boletos baseado em alguns parâmetros, como data de pagamento ou emissão entre outros e id do beneficiário.	x-itau-correlationID (string) required x-itau-flowid (string) Content-type (string) idBeneficiario (string) required nomePagador (string) cpfPagador (string) cnpjPagador (string) seuNumero (string) nossoNumero (string) codigoCarteira (string) codigoBarra (string) situacao (string) instrumentoCobranca (string) situacaoProtesto (string) situacaoVencimento (string) situacaoNegativacao (string) motivoCancelamento (string) dataEntrada (string) dataEmissao (string) dataCancelamento (string) dataVencimento (string) dataPagamento (string) orderBy (string) order (string) view (string) indicadorDescontado (string) page (integer) pageSize (integer)