Referência da API

Gerar QR Code

Cria um QR Code para identificar o SmartPOS do cliente. Depois da leitura no Connect TEF, a API envia o smartposId para o webhook configurado.

POST

/qrcode

terminalcURL

1curl -X POST "https://api.connecttef.com.br/qrcode" \2  -H "x-api-key: <sua_api_key>" \3  -H "Content-Type: application/json" \4  -d '{5    "documentoCliente": "<cpf_ou_cnpj_do_cliente_cadastrado>",6    "referencia": "loja-123-pdv-001"7  }'

Headers

Campo	Tipo	Descrição
x-api-key	string	Chave de autenticação da integração, gerada no portal do parceiro.obrigatório
Content-Type	header	Use application/json em chamadas com body.obrigatório

Campos do body

Campo	Tipo	Descrição
documentoCliente	string	CPF ou CNPJ do cliente ConnectTEF que terá o SmartPOS identificado. Envie preferencialmente somente números.obrigatório
referencia	string	Identificador livre do seu sistema para correlacionar a identificação recebida no webhook. Exemplo: loja-123-pdv-001, operador-42 ou atendimento-123.

Resposta inicial

201 Created

Resposta inicialJSON

1{2  "qrCode": "QR#22b02ed1-fe3c-42b5-9caa-b28f42829a92",3  "referencia": "loja-123-pdv-001",4  "expiresAt": 17877218485}

Campos da resposta

Campo	Tipo	Descrição
qrCode	string	Valor que deve ser convertido em QR Code visual e exibido na tela do seu sistema.obrigatório
referencia	string	Mesma referência enviada na criação do QR Code, quando informada.
expiresAt	timestamp Unix	Momento em que o QR Code deixa de ser válido.obrigatório

erro.jsonJSON

1{2  "erro": {3    "codigo": "API_KEY_INVALIDA",4    "mensagem": "API key invalida ou inativa.",5    "acao": "Confira se a chave foi copiada do portal do parceiro e se está ativa."6  }7}

HTTP	Código	Quando acontece	Como corrigir
400	`CAMPO_OBRIGATORIO`	documentoCliente não foi enviado ou está vazio.	Envie o CPF ou CNPJ do cliente cadastrado no campo documentoCliente.
401	`API_KEY_NAO_INFORMADA`	O header x-api-key não foi enviado.	Informe a chave da integração no header x-api-key.
401	`API_KEY_INVALIDA`	A chave não existe, foi rotacionada ou está inativa.	Use a chave ativa gerada no portal do parceiro.
403	`CLIENTE_NAO_AUTORIZADO`	A API key não autoriza identificação para o cliente informado.	Confira se o cliente pertence ao parceiro da chave utilizada.
500	`ERRO_INTERNO`	A API encontrou uma falha inesperada ao criar o QR Code.	Registre o status e o corpo da resposta e acione o suporte se o erro persistir.

Próximo passo

Criar pagamentoUse o smartposId recebido no webhook para enviar uma operação ao SmartPOS identificado.