Fidelidade

Consultar Saldo do Cartão

Busca o cartão-presente pelo código

GET

/v1/cartoes-presente/consulta

Escopo

fidelidade.ler

Para caixa de loja física, totem ou atendimento. Cartão cancelado ou inexistente: 404.
Até 30 consultas a cada 10 minutos por loja (impede adivinhar códigos).

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de consulta

codigostringobrigatórioquery

Os 12 caracteres do cartão, com ou sem hífens (XXXX-XXXX-XXXX).

Resposta

200 — objeto { "dados": {...} } com um Cartão-presente.

Erros possíveis

HTTP	código	quando
`400`	`json_invalido`	O corpo não é um JSON válido (confira também a codificação UTF-8).
`400`	`parametro_invalido`	Um parâmetro de consulta tem formato errado (ex.: data).
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
`404`	`nao_encontrado`	O recurso não existe nesta loja.
`404`	`rota_nao_encontrada`	Endereço inexistente na API v1.
`404`	`sem_cobranca`	O pedido não tem cobrança em um meio de pagamento.
`429`	`aguarde`	A ação foi repetida antes do intervalo mínimo (veja Retry-After).
`404`	`sem_rastreio`	O pedido ainda não tem código de rastreio.
`429`	`limite_excedido`	Mais de 120 chamadas no minuto (veja Retry-After).

import os, requests resposta = requests.get( "https://api.hoteldaslojas.com.br/v1/cartoes-presente/consulta", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/cartoes-presente/consulta'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 2, "codigo": "7W89-9DLS-962X", "valor": 50.0, "saldo": 50.0, "email": "[email protected]", "nome": "Joana", "pedido_origem_id": null, "cancelado": false, "criado_em": "2026-10-28T02:52:32-03:00" } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }