SuportePainel
Recursos da API (ERP Loja)

Lupa online

Pesquisa e criação de cards via busca online no Smart TEF.

O Smart TEF disponibiliza uma funcionalidade de pesquisa de cards acessível pela lupa no canto superior direito da interface do Smart POS.

A lupa online permite que o operador pesquise um card no Smart POS sem que ele tenha sido criado previamente na API do Smart TEF. Nessa modalidade, o Smart TEF consulta o ERP em tempo real, recebe os cards compatíveis com a busca e monta a opção de pagamento no terminal.

Como funciona

Quando habilitado por configuração, o Smart TEF pode operar em modo online e pesquisar cards em tempo real por meio de uma API disponibilizada pelo ERP integrado.

  • O operador realiza uma pesquisa no aplicativo Smart TEF.
  • O Smart TEF aciona o webhook configurado pelo parceiro.
  • O ERP responde com um ou mais cards compatíveis com a busca.
  • O card retornado pode ser exibido e processado no POS.

Configuração por loja

Esse webhook é configurado por loja, tanto na criação quanto na edição da loja.

{
  "payment_external_hook": {
    "url": "",
    "authorization_token": ""
  },
  "name": "",
  "city": ""
}
CampoDescrição
payment_external_hook.urlEndpoint do ERP que receberá a pesquisa e retornará os cards.
payment_external_hook.authorization_tokenConteúdo enviado integralmente no header Authorization.
nameNome da loja.
cityCidade da loja.

Considerações técnicas

  • A ativação do modo online depende de configuração prévia no Smart TEF.
  • O ERP precisa estar preparado para responder a consulta em tempo real.
  • O contrato de resposta deve devolver cards válidos para exibição no POS.

Exemplo de requisição para busca

Para essa utilização, o parceiro deve expor um método para consulta de cards.

curl --location '<URL configurada>' \
  --header 'Content-Type: application/json' \
  --data '{
    "search": "<string da pesquisa>"
  }'

Exemplo de retorno da busca

[
  {
    "value": 10,
    "payment_type": "PIX",
    "installments": 1,
    "charge_id": "019c967c-ff8e-7c83-94d1-df7eee6b5cbb",
    "order_type": "NRM",
    "extras": {
      "Nome": "teste pesquisa externa"
    },
    "serial_pos": "1231asa1112112123",
    "has_details": false
  }
]

O payload retornado deve seguir a mesma estrutura esperada na criação de Card de pagamento, permitindo que o Smart TEF monte o card dinamicamente a partir da resposta do ERP.