Comandos¶

CLI não oficial para a conta PJ do Inter Empresas

Uso: inter-pj [OPÇÕES] <COMANDO>

Comandos:
  saldo      Consulta o saldo da conta
  extrato    Extrato da conta: movimentações de um período (até 90 dias por consulta)
  pix        Pix: envio e consulta de pagamentos
  pagamento  Pagamentos: boletos, contas de consumo e tributos com código de barras
  auth       Tokens de acesso OAuth
  config     Arquivo de configuração e perfis

Opções globais:
  -p, --perfil <NOME>            Perfil do arquivo de configuração [env: INTER_PERFIL]
      --config <ARQUIVO>         Arquivo de configuração [padrão: ~/.config/inter-pj/config.toml]
                                 [env: INTER_CONFIG]
      --ambiente <AMBIENTE>      Ambiente: sandbox ou producao [env: INTER_AMBIENTE]
      --client-id <ID>           client_id da integração [env: INTER_CLIENT_ID]
      --certificado <ARQUIVO>    Certificado da integração (.crt) [env: INTER_CERTIFICADO]
      --chave-privada <ARQUIVO>  Chave privada da integração (.key) [env: INTER_CHAVE_PRIVADA]
      --conta-corrente <NUMERO>  Conta corrente (só quando a integração tem mais de uma conta) [env:
                                 INTER_CONTA_CORRENTE]
      --formato <FORMATO>        Formato da saída: texto (padrão), json ou csv
      --json                     Atalho para --formato json
      --separador <SEPARADOR>    Separador do CSV: "," (padrão) ou ";" (Excel em português: vírgula
                                 decimal e UTF-8 com BOM)
      --tentativas <N>           Tentativas por requisição em falhas temporárias (429, 5xx, rede)
                                 [padrão: 3] [env: INTER_TENTATIVAS]
      --sem-retentativa          Não repete requisições que falharam (o mesmo que --tentativas 1)
      --sem-cache                Não usa nem grava o cache local de tokens
  -v, --verbose...               Mostra detalhes da execução em stderr (-vv para mais detalhes)
  -h, --help                     Mostra esta ajuda
  -V, --version                  Mostra a versão

Credenciais:
  O client_secret é lido da variável de ambiente INTER_CLIENT_SECRET ou do arquivo de
  configuração (nunca de uma flag, para não ficar no histórico do shell).

Projeto não oficial, sem vínculo com o Banco Inter.
Documentação: https://github.com/edusouza/inter-pj-cli

Consulta o saldo da conta

Uso: inter-pj saldo [OPÇÕES]

Opções:
      --data <AAAA-MM-DD>  Data da consulta (AAAA-MM-DD). Sem data: saldo atual, bloqueios e limite

Extrato da conta: movimentações de um período (até 90 dias por consulta)

Uso: inter-pj extrato [OPÇÕES] [COMANDO]

Comandos:
  completo  Extrato enriquecido: detalhes de cada transação, filtros e paginação
  pdf       Salva o extrato do período em PDF

Opções:
      --inicio <AAAA-MM-DD>  Primeiro dia (AAAA-MM-DD). Padrão: 29 dias antes do fim
      --fim <AAAA-MM-DD>     Último dia (AAAA-MM-DD). Padrão: hoje
      --dividir-periodo      Divide períodos maiores que 90 dias em consultas consecutivas

Extrato enriquecido: detalhes de cada transação, filtros e paginação

Uso: inter-pj extrato completo [OPÇÕES]

Opções:
      --inicio <AAAA-MM-DD>    Primeiro dia (AAAA-MM-DD). Padrão: 29 dias antes do fim
      --fim <AAAA-MM-DD>       Último dia (AAAA-MM-DD). Padrão: hoje
      --tipo-operacao <C|D>    Apenas entradas (C) ou apenas saídas (D)
      --tipo-transacao <TIPO>  Apenas um tipo de transação (PIX, PAGAMENTO, TRANSFERENCIA,
                               BOLETO_COBRANCA, TARIFA...)
      --pagina <N>             Página a consultar, a partir de 0
      --tamanho-pagina <N>     Transações por página (até 10000; padrão da API: 50)
      --todas-paginas          Busca todas as páginas (acima de 10.000 transações, usa o modo
                               scroll)
      --dividir-periodo        Divide períodos maiores que 90 dias em consultas consecutivas (requer
                               --todas-paginas)

Salva o extrato do período em PDF

Uso: inter-pj extrato pdf [OPÇÕES]

Opções:
      --inicio <AAAA-MM-DD>  Primeiro dia (AAAA-MM-DD). Padrão: 29 dias antes do fim
      --fim <AAAA-MM-DD>     Último dia (AAAA-MM-DD). Padrão: hoje
  -o, --saida <ARQUIVO>      Arquivo a gravar ("-" para a saída padrão). Padrão:
                             extrato-<inicio>-a-<fim>.pdf
      --sobrescrever         Sobrescreve o arquivo se ele já existir

Pix: envio e consulta de pagamentos

Uso: inter-pj pix [OPÇÕES] <COMANDO>

Comandos:
  enviar     Envia um Pix (chave, copia e cola ou dados bancários), após mostrar um resumo e pedir
             confirmação
  consultar  Consulta o status e o histórico de um Pix enviado (últimos 90 dias)

Envia um Pix (chave, copia e cola ou dados bancários), após mostrar um resumo e pedir confirmação

Uso: inter-pj pix enviar [OPÇÕES]

Destino (escolha um):
      --chave <CHAVE>          Chave Pix: CPF, CNPJ, e-mail, celular (+55DD9NNNNNNNN) ou chave
                               aleatória
      --copia-e-cola <CODIGO>  Código Pix copia e cola, entre aspas
      --ispb <ISPB>            ISPB da instituição, 8 dígitos (dados bancários, para quem não tem
                               chave)

Dados bancários:
      --agencia <AGENCIA>     Agência, sem o dígito verificador
      --conta <CONTA>         Conta com o dígito verificador (1234567, 123456-7 ou 123456-X)
      --tipo-conta <TIPO>     Tipo da conta: corrente, poupanca, salario ou pagamento
      --documento <CPF/CNPJ>  CPF ou CNPJ do titular da conta
      --nome <NOME>           Nome do titular da conta

Pagamento:
      --valor <VALOR>      Valor em reais: 150,00, 1.500,00 ou 150.00 (dispensável se o copia e cola
                           já traz o valor)
      --descricao <TEXTO>  Mensagem ao recebedor (até 140 caracteres)
      --data <AAAA-MM-DD>  Agenda o Pix para o dia (AAAA-MM-DD). Padrão: agora

Segurança:
      --sim                    Confirma sem perguntar (para scripts)
      --simular                Mostra a requisição que seria enviada, sem enviar nada
      --id-idempotente <UUID>  Chave de idempotência (UUID) de um envio anterior: repete-o sem pagar
                               duas vezes

Consulta o status e o histórico de um Pix enviado (últimos 90 dias)

Uso: inter-pj pix consultar [OPÇÕES] <CODIGO>

Opções:
      --aguardar           Consulta de novo, a cada 6 segundos, até o Pix chegar a um status final
      --timeout <DURACAO>  Tempo máximo de espera com --aguardar: 60s, 5m, 1h [padrão: 60s]
  <CODIGO>                 Código da solicitação, mostrado pelo `pix enviar`

Pagamentos: boletos, contas de consumo e tributos com código de barras

Uso: inter-pj pagamento [OPÇÕES] <COMANDO>

Comandos:
  boleto  Boletos, contas de consumo e tributos com código de barras
  darf    DARF sem código de barras (tributos federais)
  lote    Lotes de 2 a 150 boletos e DARFs, a partir de um arquivo JSON ou CSV

Boletos, contas de consumo e tributos com código de barras

Uso: inter-pj pagamento boleto [OPÇÕES] <COMANDO>

Comandos:
  pagar     Paga ou agenda um boleto, conta ou tributo, após mostrar um resumo e pedir confirmação
  listar    Lista os pagamentos por código de barras de um período (até 90 dias; padrão: incluídos
            nos últimos 30 dias)
  cancelar  Cancela um pagamento agendado, após mostrá-lo e pedir confirmação

Paga ou agenda um boleto, conta ou tributo, após mostrar um resumo e pedir confirmação

Uso: inter-pj pagamento boleto pagar [OPÇÕES] <CODIGO>

Arguments:
  <CODIGO>  Linha digitável ou código de barras, entre aspas se tiver espaços

Pagamento:
      --valor <VALOR>            Valor a pagar: 150,00, 1.500,00 ou 150.00. Padrão: o valor do
                                 código
      --vencimento <AAAA-MM-DD>  Vencimento (AAAA-MM-DD). Padrão: o do boleto; contas e tributos
                                 precisam informar
      --data <AAAA-MM-DD>        Agenda o pagamento para o dia (AAAA-MM-DD). Padrão: agora
      --beneficiario <CPF/CNPJ>  CPF ou CNPJ do beneficiário, para a API conferir antes de pagar

Segurança:
      --sim      Confirma sem perguntar (para scripts)
      --simular  Mostra a requisição que seria enviada, sem enviar nada

Lista os pagamentos por código de barras de um período (até 90 dias; padrão: incluídos nos últimos
30 dias)

Uso: inter-pj pagamento boleto listar [OPÇÕES]

Opções:
      --inicio <AAAA-MM-DD>      Primeiro dia (AAAA-MM-DD). Padrão: 29 dias antes do fim
      --fim <AAAA-MM-DD>         Último dia (AAAA-MM-DD). Padrão: hoje
      --filtrar-por <DATA>       Data a que o período se refere: inclusao (padrão), pagamento ou
                                 vencimento
      --codigo <CODIGO>          Apenas os pagamentos deste boleto ou conta (linha digitável ou
                                 código de barras)
      --codigo-transacao <UUID>  Apenas o pagamento com este código de transação

Cancela um pagamento agendado, após mostrá-lo e pedir confirmação

Uso: inter-pj pagamento boleto cancelar [OPÇÕES] <CODIGO_TRANSACAO>

Opções:
  <CODIGO_TRANSACAO>  Código da transação do agendamento, mostrado por `pagamento boleto listar`

Segurança:
      --sim  Confirma sem perguntar (para scripts)

DARF sem código de barras (tributos federais)

Uso: inter-pj pagamento darf [OPÇÕES] <COMANDO>

Comandos:
  pagar   Paga um DARF (pelas opções ou por --arquivo), após mostrar um resumo e pedir confirmação
  listar  Lista os pagamentos de DARF (padrão: incluídos nos últimos 30 dias)

Paga um DARF (pelas opções ou por --arquivo), após mostrar um resumo e pedir confirmação

Uso: inter-pj pagamento darf pagar [OPÇÕES]

Origem (escolha uma):
      --arquivo <ARQUIVO>        Arquivo JSON com o DARF, nos campos da API ("-" para a entrada
                                 padrão)
      --codigo-receita <CODIGO>  Código da receita, 4 dígitos (ex.: 0220)

DARF:
      --contribuinte <CPF/CNPJ>        CPF ou CNPJ do contribuinte
      --nome-empresa <NOME>            Nome do contribuinte (até 100 caracteres)
      --telefone <TELEFONE>            Telefone do contribuinte (opcional, até 50 caracteres)
      --periodo-apuracao <AAAA-MM-DD>  Período de apuração (AAAA-MM-DD)
      --vencimento <AAAA-MM-DD>        Vencimento (AAAA-MM-DD)
      --referencia <NUMERO>            Número de referência (só dígitos, até 30)
      --descricao <TEXTO>              Descrição do pagamento (até 1000 caracteres)

Valores:
      --valor-principal <VALOR>  Valor principal: 150,00, 1.500,00 ou 150.00
      --multa <VALOR>            Multa, se houver
      --juros <VALOR>            Juros, se houver

Segurança:
      --sim      Confirma sem perguntar (para scripts)
      --simular  Mostra a requisição que seria enviada, sem enviar nada

Lista os pagamentos de DARF (padrão: incluídos nos últimos 30 dias)

Uso: inter-pj pagamento darf listar [OPÇÕES]

Opções:
      --inicio <AAAA-MM-DD>        Primeiro dia de pagamento (AAAA-MM-DD). Só com --fim: 29 dias
                                   antes dele
      --fim <AAAA-MM-DD>           Último dia de pagamento (AAAA-MM-DD). Só com --inicio: hoje
      --codigo-receita <CODIGO>    Apenas os DARFs deste código da receita
      --codigo-solicitacao <UUID>  Apenas o pagamento com este código de solicitação

Lotes de 2 a 150 boletos e DARFs, a partir de um arquivo JSON ou CSV

Uso: inter-pj pagamento lote [OPÇÕES] <COMANDO>

Comandos:
  enviar     Envia os pagamentos de um arquivo, após conferir todos, mostrar um resumo e pedir
             confirmação
  consultar  Mostra um lote e o status de cada pagamento
  modelo     Imprime um arquivo de exemplo, com dados fictícios: json (padrão) ou csv

Envia os pagamentos de um arquivo, após conferir todos, mostrar um resumo e pedir confirmação

Uso: inter-pj pagamento lote enviar [OPÇÕES]

Lote:
      --arquivo <ARQUIVO>      Arquivo JSON ou CSV com os pagamentos ("-" para a entrada padrão);
                               veja `pagamento lote modelo`
      --identificador <TEXTO>  Seu identificador do lote (até 30 caracteres); substitui o do arquivo

Segurança:
      --permitir-repetidos  Envia mesmo com pagamentos repetidos no arquivo (o mesmo código, ou o
                            mesmo DARF), que sem ela são recusados
      --sim                 Confirma sem perguntar (para scripts)
      --simular             Mostra a requisição que seria enviada, sem enviar nada

Mostra um lote e o status de cada pagamento

Uso: inter-pj pagamento lote consultar [OPÇÕES] <ID_LOTE>

Opções:
      --aguardar           Consulta de novo, a cada 6 segundos, até o lote ser processado
      --timeout <DURACAO>  Tempo máximo de espera com --aguardar: 60s, 5m, 1h [padrão: 5m]
  <ID_LOTE>                Identificador do lote, mostrado por `pagamento lote enviar`

Imprime um arquivo de exemplo, com dados fictícios: json (padrão) ou csv

Uso: inter-pj pagamento lote modelo [OPÇÕES] [FORMATO]

Opções:
  [FORMATO]  Formato do arquivo: json ou csv (separado por ";", para o Excel em português)

Tokens de acesso OAuth

Uso: inter-pj auth [OPÇÕES] <COMANDO>

Comandos:
  token   Obtém (ou reaproveita do cache) um token e mostra escopos e validade
  limpar  Remove os tokens em cache

Obtém (ou reaproveita do cache) um token e mostra escopos e validade

Uso: inter-pj auth token [OPÇÕES]

Opções:
      --escopo <ESCOPO>  Escopo do token (repita ou separe por vírgulas). Padrão: `escopos` do
                         perfil
      --renovar          Ignora o cache e pede um novo token
      --exibir           Imprime apenas o token em stdout (para uso com curl). Cuidado: é uma
                         credencial

Remove os tokens em cache

Uso: inter-pj auth limpar [OPÇÕES]

Opções:
      --todos  Remove os tokens de todos os perfis

Arquivo de configuração e perfis

Uso: inter-pj config [OPÇÕES] <COMANDO>

Comandos:
  init       Cria o arquivo de configuração a partir de um modelo comentado
  caminho    Mostra onde ficam o arquivo de configuração e o cache
  mostrar    Mostra a configuração efetiva do perfil (segredos ocultos)
  verificar  Confere o arquivo de configuração e o perfil, apontando o que corrigir

Cria o arquivo de configuração a partir de um modelo comentado

Uso: inter-pj config init [OPÇÕES]

Opções:
      --forcar  Sobrescreve o arquivo se ele já existir

Mostra onde ficam o arquivo de configuração e o cache

Uso: inter-pj config caminho [OPÇÕES]

Mostra a configuração efetiva do perfil (segredos ocultos)

Uso: inter-pj config mostrar [OPÇÕES]

Confere o arquivo de configuração e o perfil, apontando o que corrigir

Uso: inter-pj config verificar [OPÇÕES]

Opções:
      --corrigir  Troca as aspas duplas dos caminhos do Windows por aspas simples, guardando uma
                  cópia do arquivo original (config.toml.bak, sem sobrescrever uma cópia anterior)