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 cria o card de pagamento para o terminal.
Configurar busca online da loja
POST https://api.smarttef.mobi/manager/store/updateUse o token da loja. Para configurar a busca online, basta enviar payment_external_hook; os demais dados cadastrais da loja não são necessários.
{
"payment_external_hook": {
"url": "https://erp.example.com/smart-tef/busca",
"authorization_token": "Bearer token-do-erp"
}
}| Campo | Obrigatório | Descrição |
|---|---|---|
payment_external_hook.url | Sim | Endpoint do ERP que recebe a pesquisa e devolve os cards. |
payment_external_hook.authorization_token | Não | Valor enviado, sem alteração, no header Authorization da chamada ao ERP. |
O mesmo campo pode ser enviado na criação da loja pelo integrador, em Ativar loja.
Como a busca funciona
- A lupa aparece no POS sempre que a loja tem
payment_external_hookconfigurado. - O Smart TEF chama o ERP no momento da pesquisa, e o operador aguarda a resposta no POS. Responda o mais rápido possível.
- Os cards devolvidos pelo ERP são gravados no Smart TEF como pendentes (
PDT) e ficam disponíveis no POS que fez a pesquisa. - A criação desses cards não dispara webhook. O webhook de status é enviado normalmente quando o POS processa o card.
- Se o ERP responder com erro HTTP ou fora do contrato abaixo, a pesquisa falha e nenhum card é criado.
Requisição enviada ao ERP
curl --request POST '<payment_external_hook.url>' \
--header 'Content-Type: application/json' \
--header 'Authorization: <payment_external_hook.authorization_token>' \
--data '{
"search": "pedido 1234"
}'| Campo | Descrição |
|---|---|
search | Texto digitado pelo operador na lupa do POS. |
Resposta esperada do ERP
Responda com um array de cards, mesmo quando houver apenas um. Um array vazio indica que nada foi encontrado, e nenhum card é criado.
[
{
"value": 10,
"payment_type": "PIX",
"installments": 1,
"charge_id": "019c967c-ff8e-7c83-94d1-df7eee6b5cbb",
"order_type": "NRM",
"extras": {
"Nome": "Cliente Exemplo"
},
"has_details": false
}
]Cada item segue a estrutura de criação de Card de pagamento, incluindo as regras de pagamento. Apenas value é obrigatório.
Alguns campos são preenchidos pelo próprio Smart TEF e, se enviados, são substituídos:
| Campo | Valor usado |
|---|---|
cnpj | CNPJ da loja que fez a pesquisa. |
store_id | Loja que fez a pesquisa. |
serial_pos | Serial do POS que fez a pesquisa. |
payment_value | 0. |
has_details | true, salvo configuração específica da loja. |
