SuportePainel
Implantação

Referência

Status, tipos de pagamento, exibição e convenções da API.

Use esta página como apoio rápido para interpretar retornos e montar requisições para a API Smart TEF.

Status de pagamento

StatusDescrição
PDTPendente
PROC_PAGProcessando pagamento
CNCConcluído
CAN_ERPCancelado pelo ERP
REJ_PAGPagamento rejeitado
SOL_ESTEstorno solicitado
PROC_ESTProcessando estorno
ESTEstornado
REJ_ESTEstorno rejeitado

Status de impressão e formulário

StatusDescrição
PDTPendente
PROCProcessando
IMPImpresso
CNCConcluído
REJRejeitado
CAN_ERPCancelado pelo ERP

Tipos de pagamento

IDDescrição
CREDITCrédito
DEBITDébito
PIXPix
VOUCHERVoucher
OTHERSForma escolhida durante o processamento

Operações no POS

OperaçãoCor
PagamentoCinza
CancelamentoVermelho
ImpressãoAmarelo

Tipos de exibição

TipoDescrição
NRMOrdem normal, disponível na lista de operações.
CRD_UNICOOrdem direcionada a um único destino, exibida com prioridade.

Quando order_type for CRD_UNICO, informe apenas um destino: user_id ou serial_pos. Os dois campos não devem ser enviados juntos.

Regras gerais de criação

RegraAplicação
CNPJQuando informado no payload, deve pertencer ao mesmo escopo do token usado na requisição.
Destino únicoserial_pos e user_id são mutuamente exclusivos.
Duplicidade funcionalIdentificadores externos como charge_id, print_id e form_name não devem ser reutilizados enquanto houver operação pendente, processando ou em fluxo de estorno para a mesma loja.
CancelamentoCancelamentos pelo ERP se aplicam a ordens ainda pendentes.
Consulta por períodoEm listagens por período, use janelas curtas e evite reprocessar grandes intervalos quando o webhook estiver configurado.

Juros de parcelamento

ValorDescrição
F_STOREPadrão. A loja paga os juros do parcelamento.
F_CLIENTO cliente paga os juros do parcelamento.

Campos extras

O campo extras carrega informações adicionais da ordem, como CPF, CNPJ, Nome ou dados de pedido. Use has_details para definir se esses dados aparecem em uma tela auxiliar.

Convenções de retorno

  • Campos de adquirente como autorization_code, nsu_host, acquirer, coupon e payment_value podem retornar null até o fim do processamento.
  • Quando order_type for CRD_UNICO, envie somente um destino: user_id ou serial_pos.
  • No payload de pagamento, type será PAYMENT. No payload de impressão, type será PRINT.
  • Em anonimização, todo o conteúdo de extras pode ser substituído por valores mascarados.

Envelope de resposta

As APIs retornam o status HTTP e um objeto data. Em erros de validação ou regra de negócio, data.message pode conter uma lista de mensagens.

{
  "status": 400,
  "data": {
    "message": ["Loja não encontrada"],
    "timestamp": "2026-02-09T12:00:00.000Z",
    "path": "/smarttef/commands/erp/order/create"
  }
}
HTTPUso comum
400Campo inválido ou operação bloqueada por regra de negócio.
401Token ausente, inválido, bloqueado ou incompatível.
404Entidade não encontrada.
409Conflito de estado ou duplicidade funcional.