Account Balance

GET /account/balance returns your BRL balance and, when card payments are enabled, your USD balance. Credentials go in the token and secret headers.

curl https://dominipay.com/api/account/balance \
  -H "Accept: application/json" \
  -H "token: YOUR_TOKEN" \
  -H "secret: YOUR_SECRET"

Response

Without card payments:

{
  "status": "ok",
  "user_id": 1234,
  "currency_primary": "BRL",
  "balance": {
    "brl": {
      "available": 1530.45,
      "pending_withdrawals": 200.00,
      "net": 1330.45
    }
  }
}

With card payments enabled:

{
  "status": "ok",
  "user_id": 1234,
  "currency_primary": "BRL",
  "balance": {
    "brl": {
      "available": 1530.45,
      "pending_withdrawals": 200.00,
      "net": 1330.45
    },
    "usd": {
      "available": 850.00,
      "pending": 120.00,
      "total": 970.00,
      "mode": "live",
      "note": "Card payment balance. Withdraw via /configuracoes/cartao/saques."
    }
  }
}
FieldMeaning
user_idYour merchant id.
currency_primaryAlways BRL.
balance.brl.availableBRL balance (gross).
balance.brl.pending_withdrawalsBRL locked by PIX-OUT requests still in progress.
balance.brl.netavailable - pending_withdrawals.
balance.usdPresent only when card payments are enabled.
balance.usd.availableUSD you can withdraw now.
balance.usd.pendingUSD from card payments not yet released. It moves to available after the settlement period.
balance.usd.totalavailable + pending.
balance.usd.modelive, or test when you used sandbox credentials.
balance.usd.noteInformational text.

Sandbox

With sandbox credentials, balance.usd reports the sandbox card balance with mode: test. That balance is not withdrawable. The BRL block always reflects your real BRL balance.

Notes

  • Cache the result for a few seconds; the balance does not change faster than that in normal flows.
  • USD withdrawals are requested in the dashboard (Card payments, USD withdrawals) and settled in crypto.
  • A negative balance can happen if a refund or chargeback debits funds that were already withdrawn. Contact support if you see one.

Errors

HTTPWhen
400token or secret header missing.
401Invalid credentials or blocked account.
403Account limited to refunds (REFUND_ONLY).

Did this page help you?