Get your balance

What you can currently send.

GET

GET/payments/organizations/{orgId}/balance

curl -s "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/balance" \
  -H "x-api-key: $AVVIO_API_KEY"

const res = await fetch(`${process.env.AVVIO_BASE_URL}/payments/organizations/${process.env.AVVIO_ORG_ID}/balance`, {
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
  },
});
console.log(res.status, await res.json());

import os
import requests

res = requests.get(
    f"{os.environ['AVVIO_BASE_URL']}/payments/organizations/{os.environ['AVVIO_ORG_ID']}/balance",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
)
print(res.status_code, res.json())

200OK

{
  "currency": "USD",
  "amount": "13185.03",
  "balances": [
    {
      "currency": "USD",
      "amount": "13185.03"
    }
  ],
  "provider": [
    {
      "currency": "USD",
      "amount": "10000.00"
    }
  ],
  "wallet": [
    {
      "currency": "USDC",
      "network": "Ethereum",
      "amount": "3185.030147"
    }
  ],
  "unavailable": [],
  "ledger": [
    {
      "currency": "USD",
      "available": "9800.00",
      "held": "200.00",
      "total": "10000.00"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "FORBIDDEN",
  "status": 403,
  "detail": "This API key cannot access that organization",
  "resolution": "This key is scoped to a different organization.",
  "requestId": "req-9d0",
  "message": "This API key cannot access that organization",
  "statusCode": 403
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.

Responses

200Everything a payout can draw on, as one number per currency: what the payment network holds for you (provider) plus the USD stablecoins in your own wallet (wallet, per chain, USDC and USDT at face value). Some routings settle from the network's balance, others price the payout and fund it from your wallet; balances is the sum so you never have to know which. Both sources are read live and cached for up to one minute.

ledger, when present, is our own append-only record of the network-held balance, per currency, with what is currently reserved by holds. It is published beside the others and never summed into them; a difference between provider and ledger is what GET /balance_transactions exists to explain.

unavailable names any source that could not be read this time. When it is non-empty the figures are a floor, not the balance: retry before deciding you cannot fund a payout. In sandbox the balance is one provider-held USD figure and wallet is always empty.

Body

currencystringRequired
amountstringRequired
The USD headline, provider USD plus every wallet row.
balancesarray of objectRequired
Per currency, both sources summed. Size payouts against this.
Show 2 properties
- currencystringRequired
- amountstringRequired
providerarray of objectRequired
Per currency, what the payment network holds for you.
Show 2 properties
- currencystringRequired
- amountstringRequired
walletarray of objectRequired
Per chain, USD stablecoins in your own wallet. Empty when you hold none, and always empty in sandbox.
Show 3 properties
- currencystringRequired
  Allowed values:USDCUSDT
- networkstringRequired
  Chain name.
- amountstringRequired
  Token units
unavailablearray of stringRequired
Sources that failed to read this time. Empty when every figure is live; a non-empty result is not cached, so a retry re-reads.
Allowed values:networkwallet
ledgerarray of objectRequired
Per currency, from our own append-only record; empty until a movement has been recorded.
Show 4 properties
- currencystringRequired
- availablestringRequired
  What a payout can draw on right now.
- heldstringRequired
  Reserved by holds not yet converted to payouts or released.
- totalstringRequired
  available + held.

Errors

401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
A valid key that may not make this call. Nothing ran.
- FORBIDDEN: the key belongs to a different organization.
- ACCOUNT_BLOCKED: API access for your organization is suspended, and every key is refused until we lift it. Contact support.
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Partner Payouts · Funding & balance · operation getBalance

Try it: Get your balance

GET https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/balance

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

Was this page helpful?