The account’s payout balance
API reference

The account’s payout balance

The account's payout balance buckets in USD dollars: the creator side at the top level, plus `total` and `sides` for everything the account owns.

View as MarkdownUpdated Aug 19, 2026
GET/api/external/v1/balancealso served at /api/external/balance

The account's payout balance buckets in USD dollars: the creator side at the top level, plus total and sides for everything the account owns.

The top-level buckets are the creator side (own sales), unchanged since this endpoint launched. total is the full payable balance — the same numbers the Payouts page shows and a payout request pays out: creator side + agency side (income from managed creators and AI personas) + referral commission + partner shares. sides breaks total down.

Dollars, not cents

This endpoint returns USD dollars. The earnings, check-status and payouts endpoints return cents. Do not mix the units. For cents, eligibility and payout status use GET /payouts/summary.

Added on 2026-10-30

total and sides are new. The top-level fields did not change, so existing integrations keep working; read total for an agency, referral or partner account.

Bucket semantics: pending is revenue still inside the chargeback hold window; available has cleared the hold and is what a payout request pays out; processing is inside a payout currently being executed; paidOut is the lifetime total already paid. available can be negative (a refund of money already paid out is netted against future earnings).

Authentication

Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.

For a creator you manage or onboarded

GET /api/external/v1/creators/{creatorId}/balance — an agency's own key for a creator or AI persona it manages (needs canViewStats), or your app owner's own key for an account your app onboarded. The X-Dropfans-Account header still works but is deprecated. See Acting for a creator.

Responses

200Balance buckets in USD dollars.
NameTypeDescription
currencystringAlways "USD".
One of: USD
pendingnumberUSD **dollars** (not cents — unlike earnings and check-status). Creator side (own sales) still inside the chargeback hold window; not payable yet. For everything the account owns, read total.
availablenumberUSD dollars, creator side. Cleared the hold. Can be negative.
processingnumberUSD dollars, creator side. Included in a payout that is currently being sent.
paidOutnumberUSD dollars, creator side. Lifetime total of completed payouts.
totalBalanceBucketsAdded 2026-10-30. The full payable balance, USD dollars: the sum of all four sides — what the Payouts page shows and a payout request pays out (total.available).
Show child attributes
pendingnumberUSD **dollars**. Still inside the chargeback hold window.
availablenumberUSD dollars. Payable. Can be negative.
processingnumberUSD dollars. Inside a payout being sent.
paidOutnumberUSD dollars. Lifetime paid out.
sidesobjectAdded 2026-10-30. The four buckets per side, USD dollars; they sum to total. sides.creator equals the top-level buckets.
Show child attributes
creatorBalanceBucketsOwn sales (creatorPortion).
Show child attributes
pendingnumberUSD **dollars**. Still inside the chargeback hold window.
availablenumberUSD dollars. Payable. Can be negative.
processingnumberUSD dollars. Inside a payout being sent.
paidOutnumberUSD dollars. Lifetime paid out.
agencyBalanceBucketsIncome from managed creators / AI personas (agencyPortion).
Show child attributes
pendingnumberUSD **dollars**. Still inside the chargeback hold window.
availablenumberUSD dollars. Payable. Can be negative.
processingnumberUSD dollars. Inside a payout being sent.
paidOutnumberUSD dollars. Lifetime paid out.
affiliateBalanceBucketsReferral commission.
Show child attributes
pendingnumberUSD **dollars**. Still inside the chargeback hold window.
availablenumberUSD dollars. Payable. Can be negative.
processingnumberUSD dollars. Inside a payout being sent.
paidOutnumberUSD dollars. Lifetime paid out.
shareBalanceBucketsPartner shares of other accounts’ sales.
Show child attributes
pendingnumberUSD **dollars**. Still inside the chargeback hold window.
availablenumberUSD dollars. Payable. Can be negative.
processingnumberUSD dollars. Inside a payout being sent.
paidOutnumberUSD dollars. Lifetime paid out.
Example response
{
  "currency": "USD",
  "pending": 120.5,
  "available": 300.1,
  "processing": 0,
  "paidOut": 1755,
  "total": {
    "pending": 120.5,
    "available": 342.1,
    "processing": 0,
    "paidOut": 1875
  },
  "sides": {
    "creator": {
      "pending": 120.5,
      "available": 300.1,
      "processing": 0,
      "paidOut": 1755
    },
    "agency": {
      "pending": 0,
      "available": 42,
      "processing": 0,
      "paidOut": 120
    },
    "affiliate": {
      "pending": 0,
      "available": 0,
      "processing": 0,
      "paidOut": 0
    },
    "share": {
      "pending": 0,
      "available": 0,
      "processing": 0,
      "paidOut": 0
    }
  }
}

Errors

StatusBodyWhen
401{"error":"Unauthorized","code":"unauthorized"}Missing or invalid API key.
500{"error":"Failed to fetch balance"}Balance computation failed — retry later.
400{"error":"X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.","code":"invalid_account_header"}`X-Dropfans-Account` is not an account id.
400{"error":"X-Dropfans-Account names a different account than the path — send one or the other.","code":"account_mismatch"}Called under /v1/creators/{creatorId}/ with an `X-Dropfans-Account` naming another account.
403{"error":"This key cannot act for that account.","code":"account_not_managed"}The creator in the path (or `X-Dropfans-Account`) is one this key cannot act for: no ACCEPTED management by your agency and not an account your app onboarded (or it no longer holds a key bound to your app), a key minted for one creator, or someone is suspended, banned or deleted. An unknown id gets the same answer.
403{"error":"The agency does not have permission for this on that account.","code":"permission_denied","permission":"canViewStats"}For a managed creator: the agency lacks `canViewStats` on that account.
403{"error":"This app does not have the earnings API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"earnings"}Your app has the Earnings & balance [API category](/developers/concepts/api-categories) switched off.

Rate limiting

Every response carries the X-RateLimit-Tier header and, on limited tiers, the per-minute and per-day trios — read X-RateLimit-Remaining and X-RateLimit-Reset instead of hardcoding limits. Details in Rate limits.

Code samples

curl "https://www.dropfans.io/api/external/v1/balance" \
  -H "Authorization: Bearer $DROPFANS_API_KEY"

Questions? support@dropfans.io