api

API de Utilitários

Endpoints de utilidade para consultar saldos, taxas de câmbio e criptomoedas suportadas.

Atualizado: 09/03/2026

Endpoints de utilidade para consultar saldos, taxas de câmbio e criptomoedas suportadas.


get-credit-balance

Consulte seu saldo de Créditos. Os créditos são usados para o sistema de dedução de taxas da QuantaPay.

Solicitação

curl -X POST https://cloud.quantapay.app/api.php \
  -d "function=get-credit-balance" \
  -d "api-key=YOUR_API_KEY"

Resposta

{
  "success": true,
  "response": {
    "credit_balance": 150.00,
    "credit_currency": "USD"
  }
}
CampoTipoDescrição
credit_balancenumberSeu saldo de Créditos atual.
credit_currencystringA moeda do seu saldo de Créditos (geralmenteUSD).

get-balances

Consulte os saldos de criptomoedas de todos os seus endereços de carteira configurados.

Solicitação

curl -X POST https://cloud.quantapay.app/api.php \
  -d "function=get-balances" \
  -d "api-key=YOUR_API_KEY"

Resposta

Retorna dados de saldo para todos os endereços de criptomoedas configurados.

{
  "success": true,
  "response": {
    "btc": {
      "amount": "0.5432",
      "fiat": "35210.50"
    },
    "eth": {
      "amount": "12.345",
      "fiat": "45678.90"
    }
  }
}

get-exchange-rates

Obtenha a taxa de câmbio atual entre uma moeda fiduciária e uma criptomoeda.

Solicitação

curl -X POST https://cloud.quantapay.app/api.php \
  -d "function=get-exchange-rates" \
  -d "api-key=YOUR_API_KEY" \
  -d "currency_code=USD" \
  -d "cryptocurrency_code=btc"

Parâmetros

ParâmetroTipoObrigatórioDescrição
currency_codestringSimCódigo da moeda fiduciária (por exemplo,USD, EUR).
cryptocurrency_codestringSimCódigo da criptomoeda (por exemplo,btc, eth).

Resposta

{
  "success": true,
  "response": "64850.25"
}

A resposta é o preço de 1 unidade da criptomoeda na moeda fiduciária especificada.


get-fiat-value

Converta um valor de criptomoeda para seu equivalente fiduciário.

Solicitação

curl -X POST https://cloud.quantapay.app/api.php \
  -d "function=get-fiat-value" \
  -d "api-key=YOUR_API_KEY" \
  -d "amount=0.5" \
  -d "cryptocurrency_code=btc" \
  -d "currency_code=USD"

Parâmetros

ParâmetroTipoObrigatórioDescrição
amountnumberSimQuantidade de criptomoeda a ser convertida.
cryptocurrency_codestringSimCódigo da criptomoeda (por exemplo,btc, eth).
currency_codestringSimCódigo da moeda fiduciária de destino (por exemplo,USD).

Resposta

{
  "success": true,
  "response": "32425.13"
}

get-cryptocurrency-codes

Obtenha a lista de todos os códigos de criptomoedas suportados e seus agrupamentos de rede.

⚠️ Observação: Esta função está registrada no roteador da API (api.php), mas não tem um handler no backend (ajax.php). Chamá-la passará pela validação de parâmetros, mas retornará uma resposta vazia. Um handler precisa ser implementado para que este endpoint funcione.

Solicitação

curl -X POST https://cloud.quantapay.app/api.php \
  -d "function=get-cryptocurrency-codes" \
  -d "api-key=YOUR_API_KEY" \
  -d "cryptocurrency_code="

Parâmetros

ParâmetroTipoObrigatórioDescrição
cryptocurrency_codestringSimPasse uma string vazia para obter todos os códigos, ou o nome de uma blockchain (por exemplo,eth) para obter os códigos apenas para essa rede.

Resposta Esperada

{
  "success": true,
  "response": {
    "BTC": ["btc"],
    "ETH": ["eth", "usdt", "usdc", "link", "shib", "bat"],
    "SOL": ["sol"],
    "TRX": ["usdt_tron"],
    "BSC": ["bnb", "busd", "usdt_bsc"],
    "XRP": ["xrp"],
    "LTC": ["ltc"],
    "DOGE": ["doge"],
    "BCH": ["bch"],
    "ALGO": ["algo"],
    "XMR": ["xmr"]
  }
}

A resposta mapeia as redes blockchain para seus códigos de criptomoedas suportados. Tokens personalizados (adicionados via Configurações → Pagamentos → Token Personalizado) também estão incluídos.