Consultar Saldo

Retorna o saldo USD atual da conta autenticada.

Consultar Saldo

GET /v1/balance

curl -X GET "https://api.zelnum.com/api/v1/balance" \
  -H "X-API-Key: YOUR_KEY_HERE"

{
  "balance": "5.230000"
}

Campo	Tipo	Descrição
`balance`	string	Saldo disponível em USD, fixo em 6 casas decimais.

Informações da chave

Retorna os metadados da chave usada na requisição. O segredo nunca é devolvido — apenas um prefixo mascarado — para confirmar qual chave foi usada sem expor a credencial.

GET /v1/api-key

curl -X GET "https://api.zelnum.com/api/v1/api-key" \
  -H "X-API-Key: YOUR_KEY_HERE"

{
  "api_key_id": 12,
  "masked_key": "ck_xxxxxxxxx…****",
  "last_used": "2026-09-12T09:14:03.000000Z",
  "created_at": "2026-08-30T11:02:44.000000Z"
}

Campo	Tipo	Descrição
`api_key_id`	integer	Identificador da chave — útil em solicitações de suporte.
`masked_key`	string	Prefixo mascarado. A chave em texto claro nunca é retornada aqui.
`last_used`	string \| null	Data e hora da última requisição autenticada com esta chave.
`created_at`	string	Quando a chave foi criada.

As requisições à API são limitadas por chave de API, por grupo de endpoints:

Endpoints	Limite
`GET /v1/balance` · `GET /v1/api-key`	60 requisições / minuto por chave de API (120 / minuto por IP)

Erros

Status	`code`	Causa
`401`	`unauthorized`	Chave de API ausente, inválida ou inativa.
`403`	`account_banned`	Conta suspensa. Fale com o suporte.
`429`	—	Limite de requisições atingido — veja Limites de requisição.

Os dois endpoints compartilham o bucket geral: 60 requisições / minuto por chave de API.