Pular para o conteúdo
ZapCar
Developersv1

Consultar saldo

Saldo atual da carteira, em reais. É o valor que as consultas debitam.

GET/v1/saldo
GratuitoLeituraSandbox

Saldo atual da carteira, em reais (número com casas decimais). É o mesmo saldo do Portal e do Telegram. Use para monitorar e recarregar antes de acabar: quando o saldo não cobre um serviço, o POST responde 402 SALDO_INSUFICIENTE sem criar nada.

A recarga é feita no portal, na carteira (Pix ou assinatura). Com a chave de teste, o saldo é fictício e fixo e vem com ambiente: "test".

Pedido
curl "https://api.zapcarconsulta.com.br/v1/saldo" \
  -H "Authorization: Bearer $ZAPCAR_API_KEY"
Resposta
{ "saldo": 1000, "ambiente": "test" }
Testar no API Explorer (sandbox)

Requisição

Cabeçalhos

Authorizationstringobrigatório
Sua chave no formato Bearer zc_live_… (produção) ou Bearer zc_test_… (teste). O cabeçalho X-API-Key também é aceito. Ver Autenticação.

Exemplo: Bearer zc_test_…

Respostas

  • 200
    Saldo atual.Corpo: SaldoResponse
  • 401
    Chave ausente, inválida ou revogada.Corpo: ApiError
  • 429
    Rate limit excedido. Respeite o header Retry-After (segundos) antes de repetir. Não consome saldo.Corpo: ApiError
  • 500
    Falha interna inesperada. É transitória (retryable: true); informe o request_id ao suporte se persistir.Corpo: ApiError

Cabeçalhos da resposta

RateLimit-Limitintegerpode não vir
Teto de requisições da janela de 60s (120 em produção; 60 com chave de teste, em contador separado).
RateLimit-Remainingintegerpode não vir
Requisições restantes na janela atual.
RateLimit-Resetintegerpode não vir
Segundos até a janela zerar.
X-Request-Idstring (uuid)pode não vir
Id de correlação desta requisição. Informe ao suporte para localizar a chamada nos logs.