Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.noxpay.io/llms.txt

Use this file to discover all available pages before exploring further.

GET /v2/balance
Authorization: Bearer <your-api-key>

​
Response 200 OK

{
  "calculated_BRL_total_balance": 1234.56,
  "balances": {
    "USDT": {
      "calculated_BRL_balance": 500.00,
      "USDT TRC20": {
        "calculated_BRL_balance": 500.00,
        "available": 100.00,
        "in_transit": 10.00,
        "to_receive": 5.00,
        "blocked": 0.00
      }
    },
    "BRL": {
      "calculated_BRL_balance": 734.56,
      "BRL": {
        "calculated_BRL_balance": 734.56,
        "available": 734.56,
        "in_transit": 0.00,
        "to_receive": 0.00,
        "blocked": 0.00
      }
    }
  }
}

​
Campos do response

CampoTipoDescrição
calculated_BRL_total_balancefloatSoma de todos os saldos convertidos para BRL pelas taxas atuais
balancesobjectAgrupado por nome de moeda, depois por rede ou sub-conta

​
Buckets de sub-conta

Cada entrada de moeda é dividida em quatro buckets:
CampoDescrição
availableDisponível para saque imediato
in_transitEm trânsito enquanto uma transação está sendo processada
to_receivePrevisto para chegar de uma transação em andamento
blockedBloqueado para chargebacks ou retenções de conformidade
calculated_BRL_balance no nível da moeda é a soma em equivalente BRL de todas as sub-contas para aquela moeda.