SopagueDocs
v3

Guia rápido e passo a passo para instalar, configurar, ativar e realizar a primeira venda com o Simple TEF, além do manual completo de integração por CLI.

Antes de começar

Tenha em mãos o instalador recebido, o código da empresa/loja enviado pela nossa equipe e o PIN pad conectado ao computador.


Resumo do Processo

  1. Instalar o pacote do Simple TEF.
  2. Abrir o PDV CliSiTef em C:\PDVCliSiTef.
  3. Configurar o servidor SiTef e o operador.
  4. Ativar o terminal pelo Simple TEF com o número de série do PIN pad.
  5. Conferir as pastas na tela Configurações.
  6. Realizar uma venda de teste.
  7. Integrar seu sistema chamando PdvCliSitef.exe. Caso o arquivo .exe não esteja aparecendo dessa forma: verifique se o tipo do arquivo está como Aplicativo nas propriedades do arquivo.

1. Instale o Simple TEF

  1. Dê dois cliques no arquivo SimpleTEF-Setup recebido.
  2. Autorize a instalação quando o Windows solicitar.
  3. Mantenha marcada a opção de iniciar o PDV CliSiTef com o Windows.
  4. Conclua a instalação.

O instalador prepara automaticamente o Simple TEF, a CLI de integração, a pasta C:\PDVCliSiTef e as pastas C:\Client\Req, C:\Client\Resp e C:\Client\Comprovantes. Para homologação, use o instalador SimpleTEF-HMG; ele instala em C:\Program Files (x86)\SimpleTEF-HMG e usa as pastas C:\ProgramData\SimpleTEF-HMG.


2. Abra o PDV CliSiTef

Abra a pasta abaixo e execute o arquivo PDVSiTef.exe:

C:\PDVCliSiTef\PDVSiTef.exe

Importante

O PDV CliSiTef (PDVSiTef.exe) deve permanecer executando em segundo plano. O PdvCliSitef.exe é a CLI usada pelo sistema e é aberto somente durante cada comando.


3. Configure o servidor SiTef

Na tela de configuração do sistema, preencha os campos abaixo e confirme:

CampoValor a informar
Endereço do SiTeftls-prod.fiservapp.com
Código de Empresa SiTefCódigo da empresa/loja enviado pela nossa equipe
Código de Terminal SiTefOs 6 últimos dígitos do número de série do PIN pad
Porta Serial/USB - PinpadAUTO_USB
Mensagem PadrãoMensagem que aparecerá no PIN pad enquanto estiver aguardando

Tela de configuração do PDV CliSiTef com Código de Terminal 000001

Atenção

O Código de Empresa é enviado pela nossa equipe. O Código de Terminal é formado pelos 6 últimos dígitos do número de série do PIN pad.


4. Configure o operador

Abra a configuração de usuário do PDV CliSiTef e cadastre o operador que será utilizado no estabelecimento.

  1. Escolha a operação Inclusão.
  2. Informe o nome do operador.
  3. Defina a senha.
  4. Escolha o nível adequado e confirme.

Tela de cadastro de operadores no PDV CliSiTef

Configuração salva

Depois de configurar o sistema e o operador, não é necessário preencher novamente. Use 9 - Encerra para fechar a janela e deixe o PDV CliSiTef executando em segundo plano.


5. Ative o terminal no Simple TEF

  1. Abra o Simple TEF pelo atalho criado na instalação.
  2. Entre na tela Ativação.
  3. No campo Número de série do PIN pad, informe o número de série completo.
  4. Cole no campo Código de ativação o token enviado pela nossa equipe.

Clique em ATIVAR TERMINAL e aguarde a confirmação. O token será salvo automaticamente; não será necessário informá-lo novamente neste computador.


6. Confira as pastas

No Simple TEF, abra Configurações. Em uma instalação padrão no disco C:, os caminhos devem ser:

UsoCaminho padrão
RequisiçõesC:\Client\Req
RespostasC:\Client\Resp
ComprovantesC:\Client\Comprovantes
PDV CliSiTefC:\PDVCliSiTef

7. Faça uma venda de teste

  1. Confirme que o PIN pad está conectado.
  2. Confirme que o PDV CliSiTef está executando em segundo plano.
  3. Abra o Simple TEF e entre na tela Venda.
  4. Informe um valor pequeno e siga as mensagens do PIN pad.
  5. Confira se a venda foi aprovada e se o comprovante foi apresentado.

Se a venda não iniciar: abra novamente C:\PDVCliSiTef\PDVSiTef.exe, confira o PIN pad e use o comando health descrito adiante.


Checklist antes de liberar o computador

  • PDV CliSiTef aberto em segundo plano.
  • Terminal ativado.
  • Pastas conferidas.
  • Venda de teste concluída.

8. Integração por CLI

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.

8.1 Caminhos

ItemCaminho
CLIC:\Program Files (x86)\SimpleTEF\PdvCliSitef.exe
PDV CliSiTefC:\PDVCliSiTef\PDVSiTef.exe
RequisiçõesC:\Client\Req
RespostasC:\Client\Resp
ComprovantesC:\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.

8.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

8.3 Comandos disponíveis

ComandoParâmetros principaisFinalidade
venda--valor; --tipo; --parcelas; --outputPagamento em débito ou crédito
pix--valor; --outputPagamento PIX
cancelamento--valor; --tipo; --nsu-sitef; --outputCancela uma venda de cartão
reimpressao--nsu-sitef; --outputReimprime a última transação ou um NSU
ativacao--serial-number; --outputAtiva o terminal
desativacaosem parâmetros obrigatórios; --output opcionalRevoga e desvincula esta instalação do terminal
healthsem parâmetros obrigatóriosVerifica ativação e PDV CliSiTef

8.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 de cartão

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

Desativar e desvincular a instalação atual

PdvCliSitef.exe desativacao

Verificar o terminal

PdvCliSitef.exe health

8.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

CampoDescrição
statusaprovada, negada, cancelada ou erro
codigoSaidaCódigo numérico do resultado
valorCentavosValor processado em centavos
mensagemOperadorMensagem que pode ser exibida ao operador
nsuSitef / nsuHostIdentificadores retornados pela transação
linhasCupomLinhas do comprovante para impressão
codigoQrCodeConteúdo do QR Code em operações PIX, quando aplicável
caminhoPdfComprovanteCaminho do comprovante salvo, quando habilitado
ativo / tokenAtivo / pdvSitefAbertoCampos retornados pelo comando health
erroDetalhe técnico quando status for erro

Códigos de saída

CódigoSignificado
0Operação aprovada ou concluída
1Transação negada
2Operação cancelada
3Erro 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

9. Suporte rápido

SituaçãoO que conferir
PIN pad não respondeCabo, porta AUTO_USB e conexão do dispositivo
Terminal inativoAtivação com o número de série completo
PDV CliSiTef fechadoAbrir C:\PDVCliSiTef\PDVSiTef.exe
CLI não encontradaConferir a pasta escolhida na instalação
Erro na vendaExecutar 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.