Itaú

APIs do Itaú: conta corrente, boletos, Pix e pagamentos, pelo Itaú for Developers

Módulo extra: instale pelo Gerenciador de Módulos do A4A Studio.

Guia do módulo

Antes de começar

O módulo usa as APIs oficiais do Itaú pelo portal Itaú for Developers (devportal.itau.com.br). A empresa cria a aplicação no portal com as APIs que o robô vai usar (Account Statement, Boletos - Emissão e Instrução, Boleto com Pix, Recebimentos Pix, Cash Management/SISPAG e Extrato da cobrança) e recebe duas credenciais.

Client ID: identifica a aplicação; pode ficar no campo do comando. O módulo também o envia como x-itau-apikey.
Client Secret: senha da aplicação; guarde no cofre de credenciais do Studio.

Todo robô começa com "Conectar ao Itaú". A conexão pede o token de acesso (vale 5 minutos), renova sozinha antes de vencer e é usada por todos os comandos do módulo.

Ambientes

Sandbox: não pede certificado e responde sempre com dados de exemplo do Itaú. Serve para montar e testar o fluxo do robô, não para conferir valores.
Produção: dados e dinheiro reais; exige a aplicação liberada pelo Itaú (normalmente com o gerente da conta) e o certificado dinâmico.

Os endereços de produção vêm das especificações do Itaú. Se o banco informar outros, troque em "Servidor de token" e "Hosts das APIs", nos parâmetros avançados da conexão.

Certificado dinâmico (produção)

Em produção o Itaú exige mTLS com um certificado emitido por ele, o certificado dinâmico. A empresa gera um par de chaves, envia a chave pública ao Itaú, recebe por e-mail o Client ID e um token temporário e, com eles, pede o certificado (arquivo .crt). O portal tem um programa que faz esses passos ("Obter credenciais e certificado"); as credenciais do Extrato são geradas na área logada do portal.

Informe o .crt em "Certificado digital" e o .key em "Chave do certificado" (ou um .pfx com a senha no cofre).
O certificado vence: o Itaú manda um token de renovação antes do prazo. Renove e troque o arquivo nos robôs.
Nunca compartilhe a chave privada (.key).

Conta corrente

A API Account Statement mostra o saldo e o extrato da conta corrente (ou poupança), com a contraparte de cada lançamento: nome, documento e banco de quem pagou ou recebeu.

A conta é agência + conta + DAC, 12 dígitos, como o beneficiário da cobrança.
Cada lançamento traz operation (C crédito, D débito) e amount.value (sempre positivo).
"Consultar Bloqueios Judiciais" mostra as ordens judiciais na conta, com processo, tribunal e valor.

Cobrança (boletos): regras do Itaú

O beneficiário é agência (4 dígitos) + conta (7) + DAC (1), 12 dígitos sem traço, e vale em todos os comandos.
A carteira tem 3 dígitos (ex.: 109); use a do contrato de cobrança da empresa.
O boleto é emitido pela API Emissão e Instrução; o bolecode (boleto com QR Code Pix), pela API Boleto com Pix. Escolha o instrumento bolecode e informe a chave Pix da conta.
"Só simular" valida o boleto sem emiti-lo.
Juros: 05 isento, 90 percentual ao mês, 91 ao dia, 92 ao ano, 93 valor por dia. Multa: 01 valor fixo, 02 percentual, 03 isenta. Sem escolher, vale o que está no cadastro do beneficiário.
Alterar, baixar e as demais instruções usam carteira + nosso número. O Itaú tem uma instrução por mudança: "Alterar Boleto" manda uma para cada campo informado. Algumas instruções podem ficar aguardando aprovação do gerente.
"Salvar PDF do Boleto" grava a segunda via; use o idBoleto devolvido ao listar.

Pix: regras do Itaú e do Banco Central

A API Recebimentos Pix segue o padrão do Banco Central, igual ao dos outros bancos.

txid: 26 a 35 letras e números; sem txid, o módulo gera um (ou o Itaú, na cobrança imediata).
Valores com duas casas (150,00); datas de pesquisa com data e hora (o fim do dia é 23:59:59).
A devolução pode ser feita em até 90 dias depois do recebimento, total ou parcial.
A chave Pix precisa estar cadastrada na conta do Itaú.

Pagamentos (SISPAG)

A API Cash Management do SISPAG inclui pagamentos **só por Pix** (chave ou Pix Copia e Cola) e consulta todos os pagamentos da empresa (Pix, TED, boletos, tributos).

"Transferir por Pix" movimenta dinheiro: teste no Sandbox e confira o valor e a chave antes de usar em produção.
Conforme o contrato SISPAG, o pagamento incluído pode ficar pendente de autorização no internet banking.
Use a "Chave de idempotência" (ex.: o número do título): se o robô repetir o pagamento com a mesma chave, o Itaú não paga duas vezes.
"Consultar Pagamento" traz a situação e o comprovante.

Extrato da cobrança (francesa)

A API Extrato do Itaú mostra o movimento da carteira de cobrança (a "francesa"): entradas, baixas, liquidações, valores a creditar e tarifas. Não é o extrato da conta corrente (esse está em "Conta corrente").

"Consultar Extrato da Cobrança" traz os boletos movimentados num dia, ou só os totais com "Resumido".
"Listar Posições da Cobrança" traz os dias com posição e os totais de cada um, por mês de referência.
Sem movimento no dia, a lista volta vazia.

Erros e boas práticas

Erros do Itaú param o robô com o status HTTP e a mensagem do banco; use Tentar/Capturar para tratar.
O token é renovado sozinho; um 401 faz o módulo pedir um token novo e repetir a chamada uma vez.
Cada chamada leva um x-itau-correlationID novo, que o suporte do Itaú usa para rastrear o pedido.
Nunca escreva o Client Secret nem a senha do certificado no fluxo: use o cofre.

Conectar ao Itaú

itau.connect

Autentica nas APIs do Itaú (OAuth) e devolve a conexão usada pelos demais comandos

Como usar

Crie a aplicação no portal Itaú for Developers (devportal.itau.com.br) com as APIs que o robô vai usar e copie o Client ID e o Client Secret. Guarde o Client Secret no cofre de credenciais e escolha-o aqui. Comece no Sandbox, que não pede certificado; em produção informe o certificado dinâmico emitido pelo Itaú (.crt e .key) nos parâmetros avançados. A conexão fica em {itau} e é usada por todos os comandos do módulo.

Exemplo: Conecte no Sandbox com o Client ID da aplicação de testes e a credencial ITAU_CLIENT_SECRET do cofre; depois liste os boletos do beneficiário.

Campos

Campo	Tipo	Padrão	Detalhes
Ambiente *	Opção	`Sandbox (testes)`	O Sandbox responde com dados de exemplo e não pede certificadoOpções: Sandbox (testes), Produção
Client ID *	Texto		Na aplicação do Itaú for Developers; também vai como x-itau-apikey
Client Secret (cofre) *	Credencial do cofre
Variável da conexão *	Variável de saída	`itau`

+ Avançado (6)

Campo	Tipo	Padrão	Detalhes
Certificado digital (mTLS)	Arquivo		Produção: certificado dinâmico do Itaú (.crt) ou .pfx/.p12
Chave do certificado (.key)	Arquivo		Só para certificado .crt/.pem
Senha do certificado (cofre)	Credencial do cofre		Só para .pfx/.p12
Servidor de token	Texto		Vazio usa o padrão do ambienteEx.: `https://sts.itau.com.br/api/oauth/token`
Hosts das APIs	Pares chave e valor		Troca a URL base de uma API (cobranca, boletos, bolecode, pix, extratos, conta, pagamentos); vazio usa a das especificações do Itaú
Tempo limite	Número	`60 s`

Resultado: guardado na variável itau (Objeto).

Conta corrente

Consultar Saldo

itau.consultar_saldo

Saldos da conta corrente: disponível, total, bloqueado e limite

Como usar

Informe a conta (agência + conta + DAC). O resultado em {saldo} é um dicionário com cada tipo de saldo do Itaú (ex.: saldo_disponivel, saldo_total) e os detalhes em detalhes. Use {saldo.saldo_disponivel} no fluxo.

Exemplo: Antes de incluir os pagamentos do dia, consulte o saldo disponível e pare o robô se não houver saldo suficiente.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Conta (agência + conta + DAC)	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Variável do resultado	Variável de saída	`saldo`

Resultado: guardado na variável saldo (Dicionário).

Consultar Extrato

itau.consultar_extrato

Lançamentos da conta corrente no período, com a contraparte de cada um

Como usar

Informe a conta e o período. Cada item da lista em {extrato} é um lançamento com operation (C crédito, D débito), amount.value, date.accounting, literal.complete (descrição) e counterpart (nome, documento e banco de quem pagou ou recebeu). Ligue "Incluir lançamentos futuros" para trazer também os pendentes, marcados com pendente.

Exemplo: Todo dia útil, consulte o extrato de ontem e lance os créditos recebidos no contas a receber do ERP.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Conta (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Data inicial *	Texto		Ex.: `25/12/2026`
Data final	Texto		Vazio: até hojeEx.: `25/12/2026`
Variável da lista	Variável de saída	`extrato`

+ Avançado (4)

Campo	Tipo	Padrão	Detalhes
Tipo de conta	Opção	`Conta corrente`	Opções: Conta corrente, Poupança
Extrato resumido	Sim/Não	`Não`
Incluir lançamentos futuros	Sim/Não	`Não`
Buscar todas as páginas	Sim/Não	`Sim`

Resultado: guardado na variável extrato (Lista).

Consultar Bloqueios Judiciais

itau.consultar_bloqueios_judiciais

Bloqueios judiciais na conta no período, com processo, tribunal e valor

Como usar

Informe a conta e o período. Cada item da lista em {bloqueios} traz processNumber, courtName, blockDate, blockOrderValue, blockEffectiveValue e blockStatus.

Exemplo: Toda manhã, consulte os bloqueios dos últimos 7 dias e envie ao jurídico os que estiverem ativos.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Conta (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Data inicial *	Texto		Ex.: `25/12/2026`
Data final	Texto		Ex.: `25/12/2026`
Variável da lista	Variável de saída	`bloqueios`

Resultado: guardado na variável bloqueios (Lista).

Cobrança (boletos)

Registrar Boleto

itau.registrar_boleto

Emite um boleto (ou bolecode, com Pix) na carteira de cobrança do Itaú

Como usar

Informe o beneficiário (agência + conta + DAC), a carteira, o vencimento, o valor e o pagador. Para bolecode (boleto com QR Code Pix), escolha o instrumento bolecode e informe a chave Pix: ele sai pela API Boleto com Pix. Juros e multa têm campos próprios nos parâmetros avançados; desconto, protesto e negativação vão em "Campos extras", com os campos da API Emissão e Instrução. Ligue "Só simular" para validar o boleto sem emiti-lo. O resultado em {boleto} traz dados_individuais_boleto (com numero_linha_digitavel, codigo_barras e numero_nosso_numero) e, no bolecode, dados_qrcode.

Exemplo: Para cada pedido da planilha, registre um boleto com vencimento em 10 dias e envie a linha digitável por e-mail ao cliente.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Carteira *	Texto	`109`	Código da carteira de cobrança (3 dígitos)Ex.: `109`
Vencimento *	Texto		Ex.: `25/12/2026`
Valor *	Texto		Ex.: `150,00`
CPF ou CNPJ do pagador *	Texto
Nome do pagador *	Texto
Instrumento	Opção	`Boleto`	Bolecode é o boleto com QR Code PixOpções: Boleto, Bolecode (boleto + Pix)
Chave Pix	Texto		Chave da conta, para o bolecodeSó quando «Instrumento» = «Bolecode (boleto + Pix)»
Variável do resultado	Variável de saída	`boleto`

+ Avançado (19)

Campo	Tipo	Padrão	Detalhes
Seu número	Texto		Seu controle do boleto (até 10 caracteres)
Nosso número	Texto		Vazio: o Itaú gera
Data de emissão	Texto		Vazio usa hojeEx.: `25/12/2026`
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
E-mail do pagador	Texto
Espécie	Texto	`01`	Código da espécie do título (01 = duplicata mercantil)
Mensagens no boleto	Texto (várias linhas)		Uma por linha
Data limite de pagamento	Texto		Depois dela o boleto não pode ser pagoEx.: `25/12/2026`
Juros	Opção		Opções: Do contrato, Isento, Percentual ao mês, Percentual ao dia, Percentual ao ano, Valor por dia
Juros (percentual ou valor)	Texto		Percentual (ex.: 1 = 1%) ou valor por diaEx.: `1,00`Só quando «Juros» = «Percentual ao mês» ou «Percentual ao dia» ou «Percentual ao ano» ou «Valor por dia»
Multa	Opção		Opções: Do contrato, Valor fixo, Percentual, Isento
Multa (valor ou percentual)	Texto		Ex.: `2,00`Só quando «Multa» = «Valor fixo» ou «Percentual»
Só simular	Sim/Não	`Não`	Valida o boleto sem emitir (etapa simulacao)
Campos extras (JSON)	Código		Campos da API Emissão e Instrução (desconto, protesto, negativacao...); completam os do comando

Resultado: guardado na variável boleto (Dicionário).

Listar Boletos

itau.listar_boletos

Lista os boletos do beneficiário, com filtros de situação, datas e pagador

Como usar

Informe o beneficiário e, se quiser, a situação e os períodos de vencimento, emissão ou pagamento. O resultado em {boletos} é uma lista; use com Para Cada. Cada item traz idBoleto, nossoNumero, seuNumero, situacao, valor, dataVencimento e o pagador.

Exemplo: Todo dia, liste os boletos pagos ontem e dê baixa nos pedidos correspondentes no ERP.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Situação	Opção		Opções: Todas, Em aberto, Em pagamento, Pago, Cancelado
Vencimento de	Texto		Ex.: `25/12/2026`
Vencimento até	Texto		Ex.: `25/12/2026`
Pagamento de	Texto		Ex.: `25/12/2026`
Pagamento até	Texto		Ex.: `25/12/2026`
Variável da lista	Variável de saída	`boletos`

+ Avançado (7)

Campo	Tipo	Padrão	Detalhes
Emissão de	Texto		Ex.: `25/12/2026`
Emissão até	Texto		Ex.: `25/12/2026`
CPF ou CNPJ do pagador	Texto
Seu número	Texto
Nosso número	Texto
Outros filtros	Pares chave e valor		Parâmetros da API (ex.: situacaoVencimento = vencido)
Buscar todas as páginas	Sim/Não	`Sim`

Resultado: guardado na variável boletos (Lista).

Consultar Boleto

itau.consultar_boleto

Busca um boleto pelo nosso número ou pelo seu número

Como usar

Informe o beneficiário e o nosso número (ou o seu número). O resultado em {boleto} traz a situação (aberto, emPagamento, pago, cancelado), o valor, o vencimento e o pagador.

Exemplo: Antes de cobrar um cliente por telefone, consulte o boleto para ver se ele já foi pago.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Nosso número	Texto
Seu número	Texto		Usado se o nosso número ficar vazio
Variável do resultado	Variável de saída	`boleto`

Resultado: guardado na variável boleto (Dicionário).

Alterar Boleto

itau.alterar_boleto

Muda vencimento, valor, abatimento, seu número ou data limite de um boleto

Como usar

Informe o beneficiário, a carteira e o nosso número do boleto e só o que vai mudar. O resultado em {alteracao} traz a resposta do Itaú para cada instrução enviada (data_vencimento, valor_nominal, abatimento, seu_numero, data_limite_pagamento). Juros, multa, desconto e protesto: use "Instrução de Boleto".

Exemplo: Quando o cliente pede mais prazo, altere o vencimento do boleto para a nova data combinada.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Carteira *	Texto	`109`	Ex.: `109`
Nosso número *	Texto		Até 16 dígitos; devolvido ao registrar ou listar
Novo vencimento	Texto		Ex.: `25/12/2026`
Novo valor	Texto		Ex.: `150,00`
Variável do resultado	Variável de saída	`alteracao`

+ Avançado (3)

Campo	Tipo	Detalhes
Abatimento	Texto	Valor abatido no recebimento
Novo seu número	Texto
Nova data limite de pagamento	Texto	Ex.: `25/12/2026`

Resultado: guardado na variável alteracao (Dicionário).

Baixar Boleto

itau.baixar_boleto

Baixa (cancela) o boleto: ele deixa de poder ser pago

Como usar

Informe o beneficiário, a carteira e o nosso número. A resposta do Itaú fica em {baixa} (vazia quando o banco só confirma).

Exemplo: Quando o pedido é cancelado no ERP, baixe o boleto correspondente.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Carteira *	Texto	`109`	Ex.: `109`
Nosso número *	Texto		Até 16 dígitos; devolvido ao registrar ou listar
Variável do resultado	Variável de saída	`baixa`

Resultado: guardado na variável baixa (Qualquer).

Instrução de Boleto

itau.instrucao_boleto

Envia qualquer instrução da API ao boleto: juros, multa, desconto, protesto e outras

Como usar

Escolha a instrução e escreva o corpo em JSON com os campos da API. Ex.: multa {"codigo_tipo_multa": "02", "percentual_multa": "2.00000"}; juros {"codigo_tipo_juros": "90", "percentual_juros": "1.00000"}; protesto {"codigo_tipo_protesto": 1, "quantidade_dias_protesto": 5}. A resposta fica em {instrucao}.

Exemplo: Para os boletos vencidos há mais de 30 dias, envie a instrução de protesto.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Carteira *	Texto	`109`	Ex.: `109`
Nosso número *	Texto		Até 16 dígitos; devolvido ao registrar ou listar
Instrução *	Opção	`Multa`	Opções: Juros, Multa, Desconto, Protesto, Negativação, Abatimento, Vencimento, Valor, Data limite, Seu número, Pagador, Sacador avalista, Recebimento divergente, Baixa
Corpo (JSON)	Código		Campos da instrução na API
Variável do resultado	Variável de saída	`instrucao`

Resultado: guardado na variável instrucao (Qualquer).

Salvar PDF do Boleto

itau.segunda_via_boleto

Baixa a segunda via do boleto em PDF e salva no arquivo

Como usar

Informe onde salvar (uma pasta ou o caminho do .pdf) e o id do boleto (idBoleto, devolvido ao registrar ou listar). Sem o id, informe o beneficiário, a carteira e o nosso número. O caminho do PDF gravado fica em {arquivo_pdf}.

Exemplo: Depois de registrar o boleto, salve o PDF na pasta do cliente e anexe-o ao e-mail de cobrança.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Salvar em *	Arquivo		Pasta ou caminho do arquivo .pdf
Id do boleto	Texto		idBoleto (UUID) devolvido pelo Itaú
Variável do caminho	Variável de saída	`arquivo_pdf`

+ Avançado (3)

Campo	Tipo	Detalhes
Beneficiário (agência + conta + DAC)	Texto	Sem o id: 12 dígitos
Carteira	Texto	Ex.: `109`
Nosso número	Texto

Resultado: guardado na variável arquivo_pdf (Texto).

Pix

Criar Cobrança Pix Imediata

itau.criar_cobranca_imediata

Cria uma cobrança Pix com QR Code dinâmico e devolve o copia e cola

Como usar

Informe a chave Pix da conta, o valor e, se quiser, o devedor e uma mensagem. O resultado em {cobranca} traz txid, pixCopiaECola (o código para pagar), location e status ATIVA. Use o pixCopiaECola para gerar a imagem do QR Code ou enviar ao cliente. Para saber se foi pago, use Consultar Cobrança Pix (status CONCLUIDA).

Exemplo: No caixa da loja, crie uma cobrança de R$ 89,90 com expiração de 10 minutos e mostre o QR Code ao cliente.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Chave Pix do recebedor *	Texto		Chave cadastrada na conta do Itaú (CNPJ, e-mail, telefone ou aleatória)
Valor *	Texto		Ex.: `150,00`
Expiração	Número	`3600 s`
CPF/CNPJ do devedor	Texto
Nome do devedor	Texto		Obrigatório quando houver CPF/CNPJ
Mensagem ao pagador	Texto		Até 140 caracteres, aparece no app do banco
Variável do resultado	Variável de saída	`cobranca`

+ Avançado (3)

Campo	Tipo	Detalhes
txid	Texto	Vazio: o identificador é gerado e volta na resposta
Informações adicionais	Pares chave e valor
Campos extras (JSON)	Código	Outros campos da API, enviados como estão

Resultado: guardado na variável cobranca (Dicionário).

Criar Cobrança Pix com Vencimento

itau.criar_cobranca_vencimento

Cria uma cobrança Pix com data de vencimento (cobv), como um boleto Pix

Como usar

Informe a chave Pix, o valor, o vencimento e o devedor (CPF/CNPJ e nome). A cobrança pode ser paga até o vencimento mais os dias de validade. O resultado em {cobranca} traz txid e pixCopiaECola. Juros, multa, abatimento e desconto seguem o padrão do Banco Central e vão em Campos extras, no objeto valor.

Exemplo: Gere a cobrança do aluguel com vencimento no dia 10 e validade de 30 dias, e envie o copia e cola ao inquilino.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Chave Pix do recebedor *	Texto		Chave cadastrada na conta do Itaú (CNPJ, e-mail, telefone ou aleatória)
Valor *	Texto		Ex.: `150,00`
Vencimento *	Texto		dd/mm/aaaa, aaaa-mm-dd ou uma variável de data
CPF/CNPJ do devedor *	Texto
Nome do devedor *	Texto
Dias para pagar após o vencimento	Número	`30`
Mensagem ao pagador	Texto		Até 140 caracteres, aparece no app do banco
Variável do resultado	Variável de saída	`cobranca`

+ Avançado (7)

Campo	Tipo	Detalhes
txid	Texto	Vazio: o identificador é gerado e volta na resposta
E-mail do devedor	Texto
Endereço do devedor	Texto
Cidade	Texto
UF	Texto
CEP	Texto
Campos extras (JSON)	Código	Outros campos da API, enviados como estão

Resultado: guardado na variável cobranca (Dicionário).

Consultar Cobrança Pix

itau.consultar_cobranca_pix

Consulta uma cobrança Pix pelo txid: situação, valor e pagamentos

Como usar

Informe o txid e o tipo (imediata ou com vencimento). O resultado em {cobranca} traz status (ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP), valor, pixCopiaECola e, se paga, a lista pix com endToEndId e horário.

Exemplo: Depois de mostrar o QR Code, consulte a cobrança a cada 5 segundos até o status ser CONCLUIDA e libere o pedido.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
txid *	Texto		Identificador da cobrança (26 a 35 letras e números)
Tipo de cobrança *	Opção	`Imediata (cob)`	Opções: Imediata (cob), Com vencimento (cobv)
Variável do resultado	Variável de saída	`cobranca`

Resultado: guardado na variável cobranca (Dicionário).

Listar Cobranças Pix

itau.listar_cobrancas_pix

Lista as cobranças Pix criadas num período

Como usar

Informe o período e, se quiser, o tipo, a situação e o CPF/CNPJ do devedor. O resultado em {cobrancas} é uma lista; use com Para Cada.

Exemplo: Liste as cobranças CONCLUIDA de ontem e dê baixa nos pedidos do e-commerce.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
De	Texto		Data ou data e hora
Até	Texto		Vazio: agora
Tipo de cobrança *	Opção	`Imediata (cob)`	Opções: Imediata (cob), Com vencimento (cobv)
Situação	Opção		Opções: Todas, Ativa, Paga, Cancelada, Removida pelo banco
Variável da lista	Variável de saída	`cobrancas`

+ Avançado (2)

Campo	Tipo	Padrão	Detalhes
CPF/CNPJ do devedor	Texto
Buscar todas as páginas	Sim/Não	`Sim`

Resultado: guardado na variável cobrancas (Lista).

Cancelar Cobrança Pix

itau.cancelar_cobranca_pix

Cancela uma cobrança Pix ativa; o QR Code deixa de aceitar pagamento

Como usar

Informe o txid e o tipo. A cobrança passa a REMOVIDA_PELO_USUARIO_RECEBEDOR. Uma cobrança já paga não pode ser cancelada: devolva o Pix com Devolver Pix.

Exemplo: Cancele a cobrança quando o cliente desistir da compra antes de pagar.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
txid *	Texto		Identificador da cobrança (26 a 35 letras e números)
Tipo de cobrança *	Opção	`Imediata (cob)`	Opções: Imediata (cob), Com vencimento (cobv)
Variável do resultado	Variável de saída	`cobranca`

Resultado: guardado na variável cobranca (Dicionário).

Listar Pix Recebidos

itau.listar_pix_recebidos

Lista os Pix recebidos na conta num período

Como usar

Informe o período e, se quiser, o txid ou o CPF/CNPJ do pagador. Cada item da lista em {pix_recebidos} traz endToEndId, txid (se veio de cobrança), valor, horario, pagador e devolucoes.

Exemplo: Todo dia às 8h, liste os Pix recebidos no dia anterior e concilie com as notas emitidas.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
De	Texto		Data ou data e hora
Até	Texto		Vazio: agora
Variável da lista	Variável de saída	`pix_recebidos`

+ Avançado (3)

Campo	Tipo	Padrão
txid	Texto
CPF/CNPJ do pagador	Texto
Buscar todas as páginas	Sim/Não	`Sim`

Resultado: guardado na variável pix_recebidos (Lista).

Consultar Pix Recebido

itau.consultar_pix

Consulta um Pix recebido pelo endToEndId, com as devoluções

Como usar

Informe o endToEndId. O resultado em {pix} traz valor, horario, pagador, txid e devolucoes.

Exemplo: Antes de devolver um Pix, consulte-o para conferir o valor já devolvido.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
endToEndId do Pix *	Texto		Identificador do Pix recebido (32 caracteres, começa com E)
Variável do resultado	Variável de saída	`pix`

Resultado: guardado na variável pix (Dicionário).

Devolver Pix

itau.devolver_pix

Devolve todo ou parte de um Pix recebido

Como usar

Informe o endToEndId do Pix e o valor a devolver. O resultado em {devolucao} traz id, rtrId e status (EM_PROCESSAMENTO, DEVOLVIDO ou NAO_REALIZADO). A devolução é processada pelo Banco Central: consulte depois com Consultar Devolução Pix.

Exemplo: Quando um pedido for cancelado depois de pago, devolva o Pix ao cliente com a mensagem 'Pedido cancelado'.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
endToEndId do Pix *	Texto		Identificador do Pix recebido (32 caracteres, começa com E)
Valor a devolver *	Texto
Mensagem ao pagador	Texto
Variável do resultado	Variável de saída	`devolucao`

+ Avançado (1)

Campo	Tipo	Padrão	Detalhes
Id da devolução	Texto		Vazio: gerado e devolvido na resposta; guarde para consultar depois

Resultado: guardado na variável devolucao (Dicionário).

Consultar Devolução Pix

itau.consultar_devolucao_pix

Consulta a situação de uma devolução de Pix

Como usar

Informe o endToEndId do Pix e o id da devolução (devolvido por Devolver Pix). O resultado em {devolucao} traz status (EM_PROCESSAMENTO, DEVOLVIDO ou NAO_REALIZADO) e, se não realizada, o motivo.

Exemplo: Consulte a devolução até o status ser DEVOLVIDO e então envie o comprovante ao cliente.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
endToEndId do Pix *	Texto		Identificador do Pix recebido (32 caracteres, começa com E)
Id da devolução *	Texto
Variável do resultado	Variável de saída	`devolucao`

Resultado: guardado na variável devolucao (Dicionário).

Pagamentos (SISPAG)

Transferir por Pix

itau.transferir_pix

Inclui um pagamento Pix por chave ou por Pix Copia e Cola no SISPAG

Como usar

Informe a conta pagadora, o CPF/CNPJ da empresa pagadora, o valor e a chave Pix do favorecido (ou o Pix Copia e Cola de um QR Code). Conforme o contrato SISPAG, o pagamento pode ficar pendente de autorização no internet banking. O resultado em {pagamento} traz status_pagamento, cod_pagamento, recebedor e chave_idempotencia. Se o robô parar no meio, repita com a mesma "Chave de idempotência" para o Itaú não pagar duas vezes.

Exemplo: Para cada reembolso aprovado na planilha, transfira por Pix para a chave do funcionário, usando o número do reembolso como chave de idempotência.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Conta pagadora (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
CPF ou CNPJ da empresa pagadora *	Texto
Valor *	Texto		Ex.: `150,00`
Chave Pix do favorecido	Texto		CPF, CNPJ, e-mail, telefone ou chave aleatória
Pix Copia e Cola	Texto (várias linhas)		No lugar da chave, para pagar um QR Code
Variável do resultado	Variável de saída	`pagamento`

+ Avançado (8)

Campo	Tipo	Padrão	Detalhes
Data do pagamento	Texto		Vazio: hojeEx.: `25/12/2026`
Chave de idempotência	Texto		Identificador único do pagamento (ex.: número do título); vazio gera um
Referência da empresa	Texto		Até 20 caracteres, para a conciliação
Mensagem ao favorecido	Texto
Texto do comprovante	Texto
Módulo SISPAG	Opção	`Fornecedores`	Opções: Fornecedores, Diversos
Tipo da conta pagadora	Opção	`Conta corrente`	Opções: Conta corrente, Conta pagamento, Poupança
Campos extras (JSON)	Código		Campos da API SISPAG

Resultado: guardado na variável pagamento (Dicionário).

Listar Pagamentos

itau.listar_pagamentos

Pagamentos e transferências do SISPAG no período: Pix, TED, boletos e tributos

Como usar

Informe a conta, o CNPJ da empresa e o período. Cada item da lista em {pagamentos} traz id_pagamento, status, nome_favorecido, cpf_cnpj, tipo_pagamento, data_pagamento e valor_pagamento.

Exemplo: No fim do dia, liste os pagamentos não efetuados e avise o financeiro.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Conta (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
CNPJ da empresa *	Texto
Data inicial	Texto		Ex.: `25/12/2026`
Data final	Texto		Ex.: `25/12/2026`
Situação	Opção		Opções: Padrão do Itaú, A efetuar, Efetuados, Não efetuados, Todos
Variável da lista	Variável de saída	`pagamentos`

+ Avançado (5)

Campo	Tipo	Padrão	Detalhes
Nome do favorecido	Texto
Referência da empresa	Texto
Lista detalhada	Sim/Não	`Sim`	Desligado: agrupa por lote
Outros filtros	Pares chave e valor		Parâmetros da API (ex.: valor_minimo)
Buscar todas as páginas	Sim/Não	`Sim`

Resultado: guardado na variável pagamentos (Lista).

Consultar Pagamento

itau.consultar_pagamento

Detalhe de um pagamento do SISPAG: situação, favorecido, débito e comprovante

Como usar

Informe o id do pagamento. O resultado em {pagamento} traz dados_debito e dados_pagamento (status, favorecido, valor e comprovante).

Exemplo: Depois de transferir, consulte o pagamento até a situação ficar Efetuado e anexe o comprovante ao processo.

Campos

Campo	Tipo	Padrão
Conexão *	Variável	`itau`
Id do pagamento *	Texto
Variável do resultado	Variável de saída	`pagamento`

Resultado: guardado na variável pagamento (Dicionário).

Extrato da cobrança

Consultar Extrato da Cobrança

itau.consultar_extrato_cobranca

Movimentações dos boletos num dia: entradas, baixas e liquidações

Como usar

Informe o beneficiário e a data. Sem "Resumido", cada item da lista em {movimentacoes} é um boleto movimentado, com tipoMovimentacao, nossoNumero, seuNumero, pagador, valorTitulo e valorLiquidoLancado. Com "Resumido", vêm só os totais do dia. Filtre por tipo de cobrança, tipo de movimentação, nosso número ou pagador nos parâmetros avançados.

Exemplo: Todo dia útil, consulte as liquidações de ontem e concilie os recebimentos com o contas a receber.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Data *	Texto		Ex.: `25/12/2026`
Resumido	Sim/Não	`Não`	Só os totais do dia
Variável da lista	Variável de saída	`movimentacoes`

+ Avançado (6)

Campo	Tipo	Detalhes
Tipo de cobrança	Opção	Opções: Todos, Boleto, Bolecode
Tipo de movimentação	Texto	Ex.: entradas, liquidacoes, baixas
Nosso número	Texto
Seu número	Texto
Carteira	Texto
Nome do pagador	Texto

Resultado: guardado na variável movimentacoes (Lista).

Listar Posições da Cobrança

itau.listar_posicoes_cobranca

Dias com posição da carteira de cobrança, com os totais de cada dia

Como usar

Informe o beneficiário e, se quiser, o mês de referência (mm/aaaa). Cada item da lista em {posicoes} traz posicao (com dataPosicao e os totais), movimentacaoFinanceira e movimentacaoConta (valores disponíveis, a compensar e tarifas).

Exemplo: No começo do mês, liste as posições do mês anterior e monte o relatório de tarifas de cobrança.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
Beneficiário (agência + conta + DAC) *	Texto		12 dígitos sem traço: agência (4), conta (7) e DAC (1)Ex.: `150000052061`
Mês de referência	Texto		Vazio: as posições recentesEx.: `10/2026`
Variável da lista	Variável de saída	`posicoes`

Resultado: guardado na variável posicoes (Lista).

Avançado

Chamar API do Itaú

itau.call_api

Chamada livre a qualquer API do Itaú, com a autenticação da conexão

Como usar

Escolha a API, o método e o caminho (ex.: /boletos na API Boletos) e, se precisar, parâmetros de query e o corpo em JSON. A resposta em JSON fica em {resposta} como dicionário ou lista. Erros do banco param o robô com o status e a mensagem do Itaú.

Exemplo: Consulte os ativos financeiros dos boletos com GET /ativos-financeiros na API Boletos.

Campos

Campo	Tipo	Padrão	Detalhes
Conexão *	Variável	`itau`
API *	Opção	`Boletos (lista e PDF)`	Opções: Boletos (lista e PDF), Emissão e Instrução, Boleto com Pix, Pix, Extrato da cobrança, Conta (Account Statement), Pagamentos (SISPAG)
Método *	Opção	`GET`	Opções: GET, POST, PUT, PATCH, DELETE
Caminho *	Texto		Relativo à base da API, ou URL completaEx.: `/boletos`
Parâmetros de query	Pares chave e valor
Corpo (JSON)	Código		Só quando «Método» = «POST» ou «PUT» ou «PATCH»
Variável da resposta	Variável de saída	`resposta`

+ Avançado (1)

Campo	Tipo	Padrão	Detalhes
Cabeçalhos extras	Pares chave e valor		Ex.: x-itau-flowid

Resultado: guardado na variável resposta (Qualquer).