Documentação | Sopague

Para integrar seu PDV, ERP ou outro sistema, execute PdvCliSitef.exe na pasta em que o Simple TEF foi instalado. A cada operação, envie um comando e leia o JSON devolvido.

1. Caminhos

Item	Caminho
CLI	`C:\Program Files (x86)\SimpleTEF\PdvCliSitef.exe`
PDV CliSiTef	`C:\PDVCliSiTef\PDVSiTef.exe`
Requisições	`C:\Client\Req`
Respostas	`C:\Client\Resp`
Comprovantes	`C:\Client\Comprovantes`

Caminho da CLI

Se a pasta de instalação foi alterada, use o caminho escolhido durante a instalação. No HMG, o caminho padrão é C:\Program Files (x86)\SimpleTEF-HMG. Não fixe o caminho no código sem permitir configuração.

2. Formato da chamada

PdvCliSitef.exe <comando> [parâmetros]

Valores: O parâmetro --valor sempre recebe centavos inteiros. Exemplo: 1500 representa R$ 15,00.

Ativação via CLI

Na ativação via CLI, envie o token pela entrada padrão (stdin), junto com --activation-code-stdin. Não coloque o token diretamente na linha de comando. Exemplo no PowerShell:

"TOKEN_RECEBIDO" | PdvCliSitef.exe ativacao --serial-number 7500032412001566 --activation-code-stdin

3. Comandos disponíveis

Comando	Parâmetros principais	Finalidade
venda	--valor; --tipo; --parcelas; --output	Pagamento em débito ou crédito
pix	--valor; --output	Pagamento PIX
cancelamento	--valor; --tipo; --parcelas; --nsu-sitef; --output	Cancela uma venda de cartão
reimpressao	--nsu-sitef; --output	Reimprime a última transação ou um NSU
ativacao	--serial-number; --activation-code-stdin; --output	Ativa o terminal
desativacao	sem parâmetros obrigatórios; --output opcional	Revoga e desvincula esta instalação do terminal
health	sem parâmetros obrigatórios	Verifica ativação e PDV CliSiTef

4. Exemplos de requisição

Venda no débito de R$ 15,00

PdvCliSitef.exe venda --valor 1500 --tipo debito

Venda no crédito em 3 parcelas de R$ 300,00

PdvCliSitef.exe venda --valor 30000 --tipo credito --parcelas 3

PIX de R$ 50,00

PdvCliSitef.exe pix --valor 5000

Cancelar venda no crédito

PdvCliSitef.exe cancelamento --valor 1500 --tipo credito --parcelas 1 --nsu-sitef 123456789

Cancelar venda no débito

PdvCliSitef.exe cancelamento --valor 1500 --tipo debito --nsu-sitef 123456789

Reimprimir uma transação pelo NSU

PdvCliSitef.exe reimpressao --nsu-sitef 123456789

Ativar o terminal

"TOKEN_RECEBIDO" | PdvCliSitef.exe ativacao --serial-number 7500032412001566 --activation-code-stdin

Desativar e desvincular a instalação atual

PdvCliSitef.exe desativacao

Verificar o terminal

PdvCliSitef.exe health

5. Resposta da CLI

A resposta final é escrita em JSON no stdout. Mensagens de acompanhamento são escritas no stderr. O sistema integrador deve usar o JSON e o código de saída para decidir o resultado.

{
  "status": "aprovada",
  "codigoSaida": 0,
  "valorCentavos": 1500,
  "mensagemOperador": "TRANSAÇÃO APROVADA",
  "nsuSitef": "123456789",
  "nsuHost": "987654321",
  "linhasCupom": ["VIA ESTABELECIMENTO"],
  "codigoQrCode": null,
  "caminhoPdfComprovante": null,
  "erro": null
}

Campos mais usados da resposta

Campo	Descrição
`status`	`aprovada`, `negada`, `cancelada` ou `erro`
`codigoSaida`	Código numérico do resultado
`valorCentavos`	Valor processado em centavos
`mensagemOperador`	Mensagem que pode ser exibida ao operador
`nsuSitef` / `nsuHost`	Identificadores retornados pela transação
`linhasCupom`	Linhas do comprovante para impressão
`codigoQrCode`	Conteúdo do QR Code em operações PIX, quando aplicável
`caminhoPdfComprovante`	Caminho do comprovante salvo, quando habilitado
`ativo` / `tokenAtivo` / `pdvSitefAberto`	Campos retornados pelo comando `health`
`erro`	Detalhe técnico quando status for `erro`

Códigos de saída

Código	Significado
`0`	Operação aprovada ou concluída
`1`	Transação negada
`2`	Operação cancelada
`3`	Erro de comunicação, configuração ou parâmetro

Gravar a resposta em arquivo

Use --output quando quiser que a CLI também grave o JSON em um arquivo:

PdvCliSitef.exe venda --valor 1500 --output C:\PDV\resultado.json

6. Suporte rápido

Situação	O que conferir
Pinpad não responde	Cabo, porta `AUTO_USB` e conexão do dispositivo
Terminal inativo	Ativação com o número de série completo
PDV CliSiTef fechado	Abrir `C:\PDVCliSiTef\PDVSiTef.exe`
CLI não encontrada	Conferir a pasta escolhida na instalação
Erro na venda	Executar `PdvCliSitef.exe health` e conferir o JSON retornado

Ao pedir suporte

Informe a mensagem apresentada, o comando utilizado, o código de saída e o conteúdo do campo erro. Não envie senhas ou dados completos de cartão.