Skip to main content

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
      }
    }
  }
}

Response fields

FieldTypeDescription
calculated_BRL_total_balancefloatSum of all balances converted to BRL at current rates
balancesobjectKeyed by currency name, then by network or sub-account

Sub-account buckets

Each currency entry breaks down into four buckets:
FieldDescription
availableImmediately withdrawable
in_transitIn transit while a transaction is being processed
to_receiveExpected to arrive from an ongoing transaction
blockedFrozen for chargebacks or compliance holds
calculated_BRL_balance at the currency level is the BRL-equivalent sum of all sub-accounts for that currency.