Repository navigation
Pix Cobrança: cobranças Pix imediatas e com vencimento, com o QR Code, os Pix recebidos e as suas devoluções, locations, lotes de cobranças e pagamentos no sandbox.
Adicionado
inter-pj pix cob criar: cria uma cobrança Pix imediata (QR Code dinâmico) com chave, valor (opcionalmente alterável pelo pagador), expiração (30m,2h,7d), devedor, texto ao pagador e informações adicionais, conferidos antes de qualquer requisição. O txid é gerado (ou vem de--txid) e aparece no resumo; com ele, um resultado incerto sai com o código 9 e vem com o comando que consulta a cobrança e o que repete a criação sem duplicá-la, na mesma conta (com-p,--config,--ambientee as demais opções da linha de comando que escolheram a conta, como noAcompanhe comdepois da criação). Resumo, confirmação,--sim,--simulare, depois de criada, o QR Code no terminal (--qrcode) ou em PNG (--qrcode-png); uma falha do QR Code depois da criação é um aviso, com o comando que grava a imagem depois, e não um erro (#34).inter-pj pix cob revisar <txid>: altera valor, expiração, devedor, chave, texto e informações adicionais de uma cobrança imediata, ou a remove (--remover), depois de consultá-la e mostrar o antes e o depois; cobranças pagas ou removidas são recusadas sem nenhuma alteração (#34).inter-pj pix cob consultar <txid>: status, valor, criação e expiração no fuso local, devedor, location, os Pix que pagaram a cobrança (com o valor devolvido) e o copia e cola, com--qrcodee--qrcode-pngenquanto ela estiver ativa e não tiver expirado (#34).inter-pj pix cob listar: cobranças imediatas criadas em um período (datas com os dias de Brasília, qualquer que seja o fuso da máquina, ou data e hora com fuso; padrão: últimos 30 dias), com filtros de status, CPF/CNPJ do devedor e location, todas as páginas (ou--pagina), em texto com totais, JSON ou CSV com os nomes da API, que no terminal passa pelo filtro da saída em texto (#34).inter-pj pix cobv criar: cria uma cobrança Pix com vencimento pelas opções ou por--arquivo(JSON com os campos da API, ou-para a entrada padrão, compix cobv modelode exemplo): vencimento, validade após o vencimento, devedor com e-mail e endereço, multa, juros (ao dia, ao mês ou ao ano, em dias corridos ou úteis, ou um valor por dia), abatimento e desconto até 3 datas ou por dia de antecipação, conferidos antes de qualquer requisição; campos desconhecidos no arquivo são recusados e as mensagens apontam o campo. O resumo avisa sobre multa e juros que não chegam a valer e prazos de desconto já passados. O txid, a confirmação,--simular, o QR Code e o resultado incerto funcionam como empix cob criar(#35).inter-pj pix cobv modelo: imprime um arquivo de exemplo parapix cobv criar --arquivo, com dados fictícios e vencimento em 30 dias (#35).inter-pj pix cobv revisar <txid>: altera ou remove uma cobrança com vencimento, mostrando o antes e o depois; muda só o que for informado (um novo vencimento mantém a validade, e um desconto sem data vale até a véspera do vencimento) e confere o resultado com a cobrança atual, sem nenhuma alteração se falhar; cobranças pagas ou removidas são recusadas, e um resultado incerto sai com o código 9 e o comando que confere a cobrança (#35).inter-pj pix cobv consultar <txid>einter-pj pix cobv listar: a cobrança com vencimento, validade, devedor e endereço, recebedor, encargos em palavras, os Pix que a pagaram e o QR Code; a listagem tem os filtros depix cob listare--lote, e o rodapé soma o que os Pix das cobranças pagas trouxeram, com os encargos (#35).inter-pj pix recebidos listareinter-pj pix recebidos consultar <e2eId>: os Pix recebidos em um período, com filtros de cobrança (txid, com ou sem), devolução (com ou sem) e CPF/CNPJ do pagador, todas as páginas (ou--pagina), em texto com totais, JSON ou CSV (no terminal, com o filtro da saída em texto); a consulta mostra o que foi devolvido, o que está em devolução e o que ainda pode ser devolvido, com as devoluções (#36).inter-pj pix devolucao solicitar <e2eId> --valor V|--tudo: devolve um Pix recebido, todo ou em parte, com os trilhos de segurança dos pagamentos: consulta do Pix antes, com recusa local de uma devolução maior que o que resta dele; resumo com o valor por extenso e a produção em destaque; confirmação só de um terminal, ou--sim;limite_por_operacao;--simular; e um id de devolução gerado (ou--id) que torna segura a repetição de um resultado incerto, que sai com o código 9 (um script que repete o comando passa um--idfixo). Repetir um id que o Pix já tem apenas mostra a devolução existente.--naturezae--descricao; com--aguardar, acompanha até o fim (#36).inter-pj pix devolucao consultar <e2eId> <id> [--aguardar]: em que pé está uma devolução; com--aguardar, sai com 5 se ela não foi realizada (com o motivo) e 8 se o tempo acabou. Emsolicitar --aguardar, uma falha da espera depois de a API aceitar a devolução mostra a devolução aceita e sai com 9 (#36).inter-pj pix loc criar --tipo cob|cobv,listar(por tipo, com ou sem cobrança, em texto, JSON ou CSV) econsultar <id>: as locations, endereços dos QR Codes das cobranças, para criar antes e usar com--loc(#37).inter-pj pix loc desvincular <id>: desvincula a cobrança de uma location depois de consultá-la e pedir confirmação, avisando que o QR Code deixa de levar à cobrança; uma location sem cobrança é recusada sem nenhuma alteração. Um resultado incerto decriarou dedesvincularsai com o código 9 e o comando que o confere (#37).inter-pj pix lote-cobv criar <id> --arquivoerevisar <id> --arquivo: cria ou altera um lote de cobranças com vencimento a partir de um arquivo JSON (nos campos da API) ou de uma planilha CSV (uma cobrança por linha, com os caminhos dos campos da API nas colunas), compix lote-cobv modelo json|csvde exemplo. Todas as cobranças são conferidas antes do envio, e um arquivo com alguma inválida é recusado inteiro, com a linha e o campo de cada problema, txids repetidos e os estragos que o Excel faz em números longos e zeros à esquerda incluídos. Resumo com o total e as primeiras cobranças, confirmação,--sime--simular; na revisão, célula vazia não muda nada estatusremove a cobrança (#38).inter-pj pix lote-cobv consultar <id> [--aguardar],sumario <id>,situacao <id> em-processamento|criada|negadaelistar(em texto, JSON ou CSV, no terminal com o filtro da saída em texto): em que pé está cada cobrança do lote, com o motivo das negadas; com--aguardar, sai com 5 se alguma foi negada e 8 se o tempo acabou (#38).inter-pj pix cob pagar <txid>,inter-pj pix cobv pagar <txid>einter-pj pix sandbox pagar-qrcode --copia-e-cola: pagam cobranças Pix no sandbox, para testar o fluxo completo, pelo valor da cobrança ou do código (ou--valor), com o comando que confere o pagamento na mesma conta; em produção, são recusados antes de qualquer requisição (#39).- Biblioteca:
InterClient::pix, a API Pix, com as cobranças imediatas (cob):Pix::criar_cob(com o seutxid, que torna segura a repetição de uma criação de resultado incerto),criar_cob_sem_txid,revisar_cob(inclusive a remoção),consultar_cob(com os Pix que a pagaram e suas devoluções) elistar_cobs/listar_todas_cobspor período de criação, com filtros de CPF/CNPJ, location e status.CobSolicitada::validarconfere localmente a chave Pix, os valores (até 10 dígitos e 2 casas), a expiração, o devedor, os textos, as informações adicionais e as regras do Pix Saque e do Pix Troco;Txidvalida (26 a 35 letras e dígitos) e gera txids (#34). - Biblioteca: cobranças Pix com vencimento (
cobv):Pix::criar_cobv,revisar_cobv(inclusive a remoção),consultar_cobvelistar_cobvs/listar_todas_cobvs, que também filtram pelo lote.CobvSolicitada::validarconfere o devedor (nome, e-mail, endereço, UF e CEP), a multa e o abatimento (valor fixo ou percentual), os juros (as 8 modalidades), os descontos (até 3 datas, antes do vencimento, ou por dia de antecipação) e os valores, que precisam ser menores que o da cobrança quando fixos (#35). - Biblioteca: Pix recebidos e devoluções:
Pix::listar_pix_recebidos/listar_todos_pix_recebidos(período, txid, com ou sem cobrança, com ou sem devolução, CPF/CNPJ do pagador),consultar_pix_recebido,devolver(com o seuIdDevolucao, que torna segura a repetição; natureza e descrição conferidas antes do envio) econsultar_devolucao(#36). - Biblioteca: locations de payload —
Pix::criar_loc,listar_locs/listar_todas_locs(com ou sem cobrança, por tipo),consultar_loc(com o txid vinculado) edesvincular_loc(#37). - Biblioteca: lotes de cobranças com vencimento —
Pix::criar_lote_cobv(cada cobrança conferida como na criação avulsa, com o erro apontando o item, e sem txids repetidos),revisar_lote_cobv,consultar_lote_cobv(situação e problema de cada cobrança),sumario_lote_cobv,consultar_lote_cobv_por_situacaoelistar_lotes_cobv/listar_todos_lotes_cobv(#38). - Biblioteca: pagamentos de cobranças Pix no sandbox —
Pix::pagar_cob_no_sandbox,pagar_cobv_no_sandboxepagar_copia_e_cola_no_sandbox, recusados fora do sandbox antes de qualquer requisição (#39).
Alterado
- Os códigos de saída 5 e 8 valem também para
pix devolucao solicitar,pix devolucao consultarepix lote-cobv consultarcom--aguardar(devolução não realizada ou cobrança do lote negada; tempo esgotado). - Os arquivos JSON de
--arquivo(cobranças, DARF, lotes de pagamentos e de cobranças) recusam um campo repetido no mesmo objeto, com a linha, em vez de ficar com o último em silêncio (#483). - Na saída em texto, as tabelas e os blocos de rótulo e valor trocam por
�também os caracteres que invertem ou escondem texto (controles bidirecionais, de largura zero, o BOM e os separadores de linha e de parágrafo), e o filtro vale para os títulos e os rótulos, que também podem vir da API: um txid ou o nome de uma informação adicional com uma quebra de linha não forja mais uma linha empix cob consultar(#439).