Referência da API
Listar SmartPOS do cliente
Lista os SmartPOS vinculados ao CPF ou CNPJ do cliente e retorna o smartposId usado nas operações imediatas de pagamento, estorno e impressão.
GET
/v1/customers/{documentoCliente}/smartposcom-smartpos.jsonJSON
1{2 "documentoCliente": "12345678000195",3 "smartpos": [4 {5 "smartposId": "POS001",6 "adquirente": "Stone",7 "registradoEm": "2026-05-22T00:00:00.000Z"8 }9 ]10}Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
| documentoCliente | string | CPF ou CNPJ normalizado, retornado somente com números.obrigatório |
| smartpos | array | Lista de SmartPOS vinculados ao cliente. Quando não houver vínculo, a lista vem vazia.obrigatório |
| smartpos[].smartposId | string | Identificador público do SmartPOS. Use este valor no campo smartposId das operações imediatas.obrigatório |
| smartpos[].adquirente | string | Adquirente vinculada ao SmartPOS, quando disponível. |
| smartpos[].registradoEm | ISO date | Data de registro do SmartPOS, quando disponível. |
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 | DOCUMENTO_CLIENTE_INVALIDO | O documento não representa um CPF ou CNPJ válido para consulta. | Envie o CPF ou CNPJ do cliente, preferencialmente somente com números. |
| 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 consulta para o cliente informado. | Confira se o cliente pertence ao parceiro da chave utilizada. |
| 500 | ERRO_INTERNO | A API encontrou uma falha inesperada ao processar a consulta. | Registre o status e o corpo da resposta e acione o suporte se o erro persistir. |
Seção ativa: Requisição