The creator’s payout balance
The creator's payout balance buckets — the same numbers their Payouts page shows.
/api/external/balanceThe creator's payout balance buckets — the same numbers their Payouts page shows.
This endpoint returns USD dollars. The earnings and check-status endpoints return cents. Do not mix the units.
Bucket semantics: pending is revenue still inside the chargeback hold window; available has cleared the hold and pays out in the next batch; processing is inside a payout currently being executed; paidOut is the lifetime total already paid. available can be negative for agency accounts.
Authentication
Send the creator's API key as a bearer token: Authorization: Bearer dpfn_…. See Authentication & API keys.
An agency's own key can call this for a creator it manages by adding X-Dropfans-Account: <account id> (needs canViewStats). See Agencies.
Responses
| Name | Type | Description |
|---|---|---|
currency | string | Always "USD". One of: USD |
pending | number | USD **dollars** (not cents — unlike earnings and check-status). Earnings still inside the chargeback hold window; not payable yet. |
available | number | USD dollars. Cleared the hold — payable in the next payout batch. Can be negative for agency accounts. |
processing | number | USD dollars. Included in a payout that is currently PROCESSING. |
paidOut | number | USD dollars. Lifetime total of completed payouts. |
{
"currency": "USD",
"pending": 120.5,
"available": 342.1,
"processing": 0,
"paidOut": 1875
}Errors
| Status | Body | When |
|---|---|---|
| 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. |
| 403 | {"error":"This key cannot act for that account.","code":"account_not_managed"} | `X-Dropfans-Account` names an account this key cannot act for: not an agency’s own key, no ACCEPTED management, or the agency or account 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"} | With `X-Dropfans-Account`: the agency lacks `canViewStats` on that account. |
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/balance" \
-H "Authorization: Bearer $DROPFANS_API_KEY"const res = await fetch(`https://www.dropfans.io/api/external/balance`, {
headers: {
Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
},
});
console.log(await res.json());import os
import requests
res = requests.get(
"https://www.dropfans.io/api/external/balance",
headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
)
print(res.json())Questions? [email protected]