> ## Documentation Index > Fetch the complete documentation index at: https://www.dropfans.io/developers/llms.txt > Use this file to discover all available pages before exploring further. # GET /api/external/payouts/summary — Payout balance, eligibility and status > Everything a "Pay out" button needs in one call: balances, the minimum, the payout method and whether a payout request would be accepted right now. - Source: https://www.dropfans.io/developers/reference/get-payout-summary - Section: API reference - OpenAPI: https://www.dropfans.io/developers/openapi.json Everything a "Pay out" button needs in one call: balances, the minimum, the payout method and whether a payout request would be accepted right now. It returns the balance per bucket and per side, the minimum, the default payout method (masked), the open request, whether a payout is being sent, the upcoming releases, and whether a payout request would be accepted right now. All money is integer **cents**. The balance is everything the account owns — its creator side (own sales), agency side (income from managed creators and AI personas), referral commission and partner shares — the same totals as the creator's Payouts page. `ineligibleReasons` lists **every** gate that fails, in the order [POST /payouts/requests](https://www.dropfans.io/developers/reference/create-payout-request.md) checks them, with the same codes it answers with: `kyc_required`, `payouts_disabled`, `consumer_account`, `no_method`, `masspay_not_activated`, `below_minimum`, `request_open`, `in_flight`. ## Authentication `Authorization: Bearer dpfn_...` — an API key generated in the dashboard (Vault → API Connect). By default the key acts for the one account it belongs to. Missing or invalid keys return 401 `{"error":"Unauthorized","code":"unauthorized"}`. Optional `X-Dropfans-Account: ` — with a verified agency's own key, act for a creator or AI persona the agency manages (ids from GET /api/external/agency/creators); the agency needs `canViewStats` on that account. The response echoes the account acted on in the same header. ## Responses ### 200 The summary. Money in cents. | Field | Type | Required | Description | |---|---|---|---| | `accountId` | string | yes | The account this describes. | | `currency` | `USD` | yes | Always "USD". | | `pendingCents` | integer | yes | Integer **cents**. Money the account owns (all sides) still inside the chargeback hold window; not payable yet. | | `availableCents` | integer | yes | Integer cents. Money the account owns (all sides) that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings). | | `processingCents` | integer | yes | Integer cents. Money the account owns (all sides) inside a payout that is being sent. | | `paidOutCents` | integer | yes | Integer cents. Lifetime money the account owns (all sides) already paid out. | | `sides` | object | yes | The same four buckets per side, integer cents. | | `sides.creator` | PayoutBuckets | yes | Own sales. | | `sides.agency` | PayoutBuckets | yes | Income from managed creators / AI personas. | | `sides.affiliate` | PayoutBuckets | yes | Referral commission. | | `sides.share` | PayoutBuckets | yes | Partner shares of other accounts’ sales. | | `requestableCents` | integer | yes | Integer cents a payout request would ask for right now: the available balance of every side that has money and no open request. | | `minimumPayoutCents` | integer | yes | Integer cents. The available balance must reach this before a payout can be requested. 0 = no minimum. | | `payoutsEnabled` | boolean | yes | False when Dropfans has paused payouts for the account. | | `kycVerified` | boolean | yes | True once the account passed the ID check. | | `defaultMethod` | PayoutMethodSummary \\| null | | Where payouts go, masked. Null when no method is set up (the creator adds one in the dashboard). | | `openRequest` | Payout \\| null | | The newest open payout request (requested, approved or processing), or null. | | `inFlight` | boolean | yes | True while a payout is pending or processing. | | `upcoming` | object[] | yes | Creator-side earnings and partner shares still on hold, by the UTC day they become available. Soonest first. | | `eligible` | boolean | yes | True when POST /api/external/payouts/requests would be accepted now. | | `ineligibleReasons` | string[] | yes | Every reason it would be refused, in the order the request checks them. Empty when eligible. | ```json { "accountId": "clx2f8a1b0001qw3k", "currency": "USD", "pendingCents": 12050, "availableCents": 34210, "processingCents": 0, "paidOutCents": 187500, "sides": { "creator": { "pendingCents": 12050, "availableCents": 34210, "processingCents": 0, "paidOutCents": 175500 }, "agency": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 12000 }, "affiliate": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 0 }, "share": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 0 } }, "requestableCents": 34210, "minimumPayoutCents": 2000, "payoutsEnabled": true, "kycVerified": true, "defaultMethod": { "id": "clxpm0001method", "type": "MASSPAY", "isDefault": true, "nickname": null, "label": "Payout wallet · SWE", "holderType": "INDIVIDUAL", "createdAt": "2026-09-02T10:00:00.000Z", "paxum": null, "masspay": { "country": "SWE", "currency": null, "payerName": null, "activated": true }, "bank": null }, "openRequest": null, "inFlight": false, "upcoming": [ { "availableOn": "2026-11-04", "amountCents": 4500 } ], "eligible": true, "ineligibleReasons": [] } ``` ## Errors | Status | Body | When | |---|---|---| | 401 | `{"error":"Unauthorized","code":"unauthorized"}` | Missing or invalid API key. | | 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. | ## Notes `requestableCents` is what a request would ask for: the available balance of every side that has money and no open request. The minimum is checked against the combined `availableCents`. A negative `availableCents` (a refund of money already paid out) is netted against future earnings. ## Rate limiting Per-key fixed windows by tier (Personal 60/min · 5,000/day; approved apps 300/min · 50,000/day; Dropfans-operated integrations exempt). Read the live values from X-RateLimit-Tier, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and their -Day variants; a 429 carries Retry-After and `{"error":"Rate limit exceeded","code":"rate_limited"}`. See [Rate limits](https://www.dropfans.io/developers/concepts/rate-limits.md). ## Code samples ### curl ```bash curl "https://www.dropfans.io/api/external/payouts/summary" \ -H "Authorization: Bearer $DROPFANS_API_KEY" ``` ### Node ```javascript const res = await fetch(`https://www.dropfans.io/api/external/payouts/summary`, { headers: { Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`, }, }); console.log(await res.json()); ``` ### Python ```python import os import requests res = requests.get( "https://www.dropfans.io/api/external/payouts/summary", headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"}, ) print(res.json()) ``` ## OpenAPI ```json { "method": "GET", "path": "/api/external/payouts/summary", "operationId": "getPayoutSummary", "tags": [ "payouts" ], "summary": "Payout balance, eligibility and status", "description": "Everything a \"Pay out\" button needs in one call: balances, the minimum, the payout method and whether a payout request would be accepted right now.\n\nIt returns the balance per bucket and per side, the minimum, the default payout method (masked), the open request, whether a payout is being sent, the upcoming releases, and whether a payout request would be accepted right now.\n\nAll money is integer **cents**. The balance is everything the account owns — its creator side (own sales), agency side (income from managed creators and AI personas), referral commission and partner shares — the same totals as the creator's Payouts page.\n\n`ineligibleReasons` lists **every** gate that fails, in the order [POST /payouts/requests](https://www.dropfans.io/developers/reference/create-payout-request.md) checks them, with the same codes it answers with: `kyc_required`, `payouts_disabled`, `consumer_account`, `no_method`, `masspay_not_activated`, `below_minimum`, `request_open`, `in_flight`.", "parameters": [ { "name": "X-Dropfans-Account", "in": "header", "required": false, "description": "Agencies only. With a verified agency’s own key, the id of a creator or AI persona the agency manages (from GET /api/external/agency/creators): the request then acts as that account, exactly as if it were sent with that account’s own key. Account ids only — usernames are refused (400 invalid_account_header). Checked on every request: the management must be ACCEPTED, nobody may be suspended, banned or deleted (else 403 account_not_managed), and the agency needs the endpoint’s permission on that account (else 403 permission_denied). Omit it to act as the key’s own account.", "schema": { "type": "string", "pattern": "^c[a-z0-9]{20,32}$" }, "example": "cmh4v2q8k0003xy9z7w6v5u4t" } ], "responses": { "200": { "description": "The summary. Money in cents.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } }, "X-Dropfans-Account": { "description": "The id of the account this request acted on — the key’s own account, or the managed account named in the X-Dropfans-Account request header. Assert it when acting for several accounts.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string", "description": "The account this describes.", "example": "clx2f8a1b0001qw3k" }, "currency": { "type": "string", "description": "Always \"USD\".", "enum": [ "USD" ] }, "pendingCents": { "type": "integer", "description": "Integer **cents**. Money the account owns (all sides) still inside the chargeback hold window; not payable yet.", "example": 12050 }, "availableCents": { "type": "integer", "description": "Integer cents. Money the account owns (all sides) that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings).", "example": 34210 }, "processingCents": { "type": "integer", "description": "Integer cents. Money the account owns (all sides) inside a payout that is being sent.", "example": 0 }, "paidOutCents": { "type": "integer", "description": "Integer cents. Lifetime money the account owns (all sides) already paid out.", "example": 187500 }, "sides": { "type": "object", "properties": { "creator": { "type": "object", "properties": { "pendingCents": { "type": "integer", "description": "Integer **cents**. Money still inside the chargeback hold window; not payable yet.", "example": 12050 }, "availableCents": { "type": "integer", "description": "Integer cents. Money that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings).", "example": 34210 }, "processingCents": { "type": "integer", "description": "Integer cents. Money inside a payout that is being sent.", "example": 0 }, "paidOutCents": { "type": "integer", "description": "Integer cents. Lifetime money already paid out.", "example": 187500 } }, "required": [ "pendingCents", "availableCents", "processingCents", "paidOutCents" ] }, "agency": { "type": "object", "properties": { "pendingCents": { "type": "integer", "description": "Integer **cents**. Money still inside the chargeback hold window; not payable yet.", "example": 12050 }, "availableCents": { "type": "integer", "description": "Integer cents. Money that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings).", "example": 34210 }, "processingCents": { "type": "integer", "description": "Integer cents. Money inside a payout that is being sent.", "example": 0 }, "paidOutCents": { "type": "integer", "description": "Integer cents. Lifetime money already paid out.", "example": 187500 } }, "required": [ "pendingCents", "availableCents", "processingCents", "paidOutCents" ] }, "affiliate": { "type": "object", "properties": { "pendingCents": { "type": "integer", "description": "Integer **cents**. Money still inside the chargeback hold window; not payable yet.", "example": 12050 }, "availableCents": { "type": "integer", "description": "Integer cents. Money that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings).", "example": 34210 }, "processingCents": { "type": "integer", "description": "Integer cents. Money inside a payout that is being sent.", "example": 0 }, "paidOutCents": { "type": "integer", "description": "Integer cents. Lifetime money already paid out.", "example": 187500 } }, "required": [ "pendingCents", "availableCents", "processingCents", "paidOutCents" ] }, "share": { "type": "object", "properties": { "pendingCents": { "type": "integer", "description": "Integer **cents**. Money still inside the chargeback hold window; not payable yet.", "example": 12050 }, "availableCents": { "type": "integer", "description": "Integer cents. Money that cleared the hold and is not in a payout yet. Can be negative (a refund of money already paid out is netted against future earnings).", "example": 34210 }, "processingCents": { "type": "integer", "description": "Integer cents. Money inside a payout that is being sent.", "example": 0 }, "paidOutCents": { "type": "integer", "description": "Integer cents. Lifetime money already paid out.", "example": 187500 } }, "required": [ "pendingCents", "availableCents", "processingCents", "paidOutCents" ] } }, "required": [ "creator", "agency", "affiliate", "share" ], "description": "The same four buckets per side, integer cents." }, "requestableCents": { "type": "integer", "description": "Integer cents a payout request would ask for right now: the available balance of every side that has money and no open request.", "example": 34210 }, "minimumPayoutCents": { "type": "integer", "description": "Integer cents. The available balance must reach this before a payout can be requested. 0 = no minimum.", "example": 2000 }, "payoutsEnabled": { "type": "boolean", "description": "False when Dropfans has paused payouts for the account." }, "kycVerified": { "type": "boolean", "description": "True once the account passed the ID check." }, "defaultMethod": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Payout method id.", "example": "clxpm0001method" }, "type": { "type": "string", "description": "Provider method type.", "enum": [ "PAXUM_P2P", "MASSPAY", "BANK_SWIFT" ] }, "isDefault": { "type": "boolean", "description": "True for the method payouts go to." }, "nickname": { "type": [ "string", "null" ], "description": "The creator’s own label for it." }, "label": { "type": "string", "description": "Display label, masked (see Payout.method.label).", "example": "Paxum · j***@example.com" }, "holderType": { "type": [ "string", "null" ], "description": "Whether it was set up for the person or the company.", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "createdAt": { "type": "string", "description": "When the method was added.", "format": "date-time" }, "paxum": { "type": [ "object", "null" ], "properties": { "email": { "type": [ "string", "null" ], "description": "Masked Paxum e-mail, e.g. \"j***@example.com\".", "example": "j***@example.com" }, "lookupStatus": { "type": [ "string", "null" ], "description": "Whether the e-mail is a live Paxum account: active, inactive, not_found, unconfigured.", "example": "active" }, "verificationStatus": { "type": [ "string", "null" ], "description": "Paxum identity match against the ID check: PENDING, COMPLETED, MISMATCH, UNAVAILABLE." } }, "description": "PAXUM_P2P only." }, "masspay": { "type": [ "object", "null" ], "properties": { "country": { "type": [ "string", "null" ], "description": "ISO 3166-1 alpha-3 country.", "example": "SWE" }, "currency": { "type": [ "string", "null" ], "description": "Payout currency (ISO 4217), when chosen." }, "payerName": { "type": [ "string", "null" ], "description": "Payout option name, when chosen." }, "activated": { "type": "boolean", "description": "True once the payee finished the wallet activation. Payout requests to a wallet need it." } }, "required": [ "activated" ], "description": "MASSPAY (payout wallet) only." }, "bank": { "type": [ "object", "null" ], "properties": { "last4": { "type": [ "string", "null" ], "description": "Last 4 characters of the account number. The full IBAN / SWIFT is never returned.", "example": "1234" }, "country": { "type": [ "string", "null" ], "description": "Bank country (ISO alpha-2)." }, "bankName": { "type": [ "string", "null" ], "description": "Bank name." } }, "description": "BANK_SWIFT only." } }, "required": [ "id", "type", "isDefault", "label", "createdAt" ] }, { "type": "null" } ], "description": "Where payouts go, masked. Null when no method is set up (the creator adds one in the dashboard)." }, "openRequest": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the row. Unique across the three kinds — use it with GET /api/external/payouts/{id}.", "example": "clxpo0001payout" }, "kind": { "type": "string", "description": "`payout`: sent by Dropfans (Paxum, MassPay wallet load, or settled by an admin). `manual`: paid outside the platform and recorded by an admin. `request`: a payout request the account made that has not been fulfilled into a payout yet.", "enum": [ "payout", "manual", "request" ] }, "status": { "type": "string", "description": "Requests: `requested` → `approved` → (`processing` for Paxum, from the moment they are made) → `paid`, or `rejected` / `cancelled`. Payouts: `pending` (in a batch, not sent yet) → `processing` (sent) → `paid` or `failed`; `cancelled` when an attempt was dropped. Manual payouts are always `paid`.", "enum": [ "requested", "approved", "pending", "processing", "paid", "failed", "cancelled", "rejected" ] }, "amountCents": { "type": "integer", "description": "Integer **cents**. What is paid out (negative only on a reversal row).", "example": 34210 }, "currency": { "type": "string", "description": "Always \"USD\".", "enum": [ "USD" ] }, "side": { "type": "string", "description": "Which balance it draws from: `creator` (own sales), `agency` (income from managed creators / AI personas), `affiliate` (referral commission), `share` (partner shares of other accounts’ sales), or `combined` (several sides in one transfer — see `sides`).", "example": "creator" }, "sides": { "type": "object", "properties": { "creatorCents": { "type": "integer", "description": "Creator side, cents.", "example": 34210 }, "agencyCents": { "type": "integer", "description": "Agency side, cents.", "example": 0 }, "affiliateCents": { "type": "integer", "description": "Referral commission, cents.", "example": 0 }, "shareCents": { "type": "integer", "description": "Partner shares, cents.", "example": 0 } }, "required": [ "creatorCents", "agencyCents", "affiliateCents", "shareCents" ], "description": "The amount split by side, integer cents. Adds up to `amountCents`." }, "method": { "type": [ "object", "null" ], "properties": { "type": { "type": "string", "description": "Provider method type.", "enum": [ "PAXUM_P2P", "MASSPAY", "BANK_SWIFT" ] }, "label": { "type": "string", "description": "Display label — the creator’s nickname, or e.g. \"Paxum · j***@example.com\", \"Payout wallet · SWE\", \"Bank transfer · ••••1234\". Never a full e-mail, IBAN or token.", "example": "Paxum · j***@example.com" } }, "required": [ "type", "label" ], "description": "The destination frozen when the payout or request was made, masked. Null for manual payouts." }, "note": { "type": [ "string", "null" ], "description": "Requests: the note sent with the request. Manual payouts: the note the admin recorded for the payee. Otherwise null." }, "failureMessage": { "type": [ "string", "null" ], "description": "Why a `failed` payout failed, as reported by the provider. Null unless `status` is `failed`." }, "invoiceNumber": { "type": [ "integer", "null" ], "description": "Payout invoice number once the invoice exists. The invoice itself is in the dashboard.", "example": 1042 }, "requestId": { "type": [ "string", "null" ], "description": "kind `payout` / `manual`: the request this payout fulfilled, if any." }, "payoutId": { "type": [ "string", "null" ], "description": "kind `request`: the payout or manual payout that fulfilled it, if any." }, "createdAt": { "type": "string", "description": "When the payout was created or the request made. The list is ordered by this.", "format": "date-time" }, "initiatedAt": { "type": [ "string", "null" ], "description": "When the payout was sent to the provider.", "format": "date-time" }, "paidAt": { "type": [ "string", "null" ], "description": "When it was paid. Null unless `status` is `paid` (requests carry it on the fulfilling payout instead).", "format": "date-time" }, "failedAt": { "type": [ "string", "null" ], "description": "When it failed. Null unless `status` is `failed`.", "format": "date-time" }, "reversedAt": { "type": [ "string", "null" ], "description": "Set on a paid wallet load that was sent back (spendback): the money is available again. Its negative twin has `reversalOfId`. Both are hidden from GET /payouts unless includeReversed=true.", "format": "date-time" }, "reversalOfId": { "type": [ "string", "null" ], "description": "Set on the negative row that reverses the payout with this id." } }, "required": [ "id", "kind", "status", "amountCents", "currency", "side", "sides", "createdAt" ] }, { "type": "null" } ], "description": "The newest open payout request (requested, approved or processing), or null." }, "inFlight": { "type": "boolean", "description": "True while a payout is pending or processing." }, "upcoming": { "type": "array", "items": { "type": "object", "properties": { "availableOn": { "type": "string", "description": "YYYY-MM-DD (UTC).", "format": "date", "example": "2026-11-04" }, "amountCents": { "type": "integer", "description": "Integer cents released that day.", "example": 4500 } }, "required": [ "availableOn", "amountCents" ], "description": "One day." }, "description": "Creator-side earnings and partner shares still on hold, by the UTC day they become available. Soonest first." }, "eligible": { "type": "boolean", "description": "True when POST /api/external/payouts/requests would be accepted now." }, "ineligibleReasons": { "type": "array", "items": { "type": "string", "description": "A reason code — the same `code` POST /payouts/requests answers with.", "enum": [ "kyc_required", "payouts_disabled", "consumer_account", "no_method", "masspay_not_activated", "below_minimum", "request_open", "in_flight" ] }, "description": "Every reason it would be refused, in the order the request checks them. Empty when eligible." } }, "required": [ "accountId", "currency", "pendingCents", "availableCents", "processingCents", "paidOutCents", "sides", "requestableCents", "minimumPayoutCents", "payoutsEnabled", "kycVerified", "inFlight", "upcoming", "eligible", "ineligibleReasons" ] }, "example": { "accountId": "clx2f8a1b0001qw3k", "currency": "USD", "pendingCents": 12050, "availableCents": 34210, "processingCents": 0, "paidOutCents": 187500, "sides": { "creator": { "pendingCents": 12050, "availableCents": 34210, "processingCents": 0, "paidOutCents": 175500 }, "agency": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 12000 }, "affiliate": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 0 }, "share": { "pendingCents": 0, "availableCents": 0, "processingCents": 0, "paidOutCents": 0 } }, "requestableCents": 34210, "minimumPayoutCents": 2000, "payoutsEnabled": true, "kycVerified": true, "defaultMethod": { "id": "clxpm0001method", "type": "MASSPAY", "isDefault": true, "nickname": null, "label": "Payout wallet · SWE", "holderType": "INDIVIDUAL", "createdAt": "2026-09-02T10:00:00.000Z", "paxum": null, "masspay": { "country": "SWE", "currency": null, "payerName": null, "activated": true }, "bank": null }, "openRequest": null, "inFlight": false, "upcoming": [ { "availableOn": "2026-11-04", "amountCents": 4500 } ], "eligible": true, "ineligibleReasons": [] } } } }, "400": { "description": "`X-Dropfans-Account` is not an account id.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "X-Dropfans-Account must be an account id (from GET /api/external/agency/creators), not a username.", "code": "invalid_account_header" } } } }, "401": { "description": "Missing or invalid API key.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "Unauthorized", "code": "unauthorized" } } } }, "403": { "description": "`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). Also: With `X-Dropfans-Account`: the agency lacks `canViewStats` on that account.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "This key cannot act for that account.", "code": "account_not_managed" } } } }, "429": { "description": "Rate limit exceeded for the current minute or day window. Wait Retry-After seconds and retry.", "headers": { "X-RateLimit-Tier": { "description": "Rate-limit tier of the key: personal, app or first_party (first_party is unlimited).", "schema": { "type": "string", "enum": [ "personal", "app", "first_party" ] } }, "X-RateLimit-Limit": { "description": "Requests allowed per minute for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining": { "description": "Requests left in the current minute window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset": { "description": "Epoch seconds when the minute window resets.", "schema": { "type": "integer" } }, "X-RateLimit-Limit-Day": { "description": "Requests allowed per UTC day for this key (absent on first_party).", "schema": { "type": "integer" } }, "X-RateLimit-Remaining-Day": { "description": "Requests left in the current UTC day window.", "schema": { "type": "integer" } }, "X-RateLimit-Reset-Day": { "description": "Epoch seconds when the day window resets.", "schema": { "type": "integer" } }, "Retry-After": { "description": "Seconds to wait before retrying (sent with 429s).", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Human-readable message.", "example": "Rate limit exceeded" }, "code": { "type": "string", "description": "Machine-readable code: unauthorized, app_suspended, first_party_only, rate_limited, username_required, invalid_account_header, account_not_managed, permission_denied, account_header_not_allowed, agency_key_required — plus endpoint-specific codes listed on each reference page.", "example": "rate_limited" } }, "required": [ "error", "code" ] }, "example": { "error": "Rate limit exceeded", "code": "rate_limited" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "curl", "source": "curl \"https://www.dropfans.io/api/external/payouts/summary\" \\\n -H \"Authorization: Bearer $DROPFANS_API_KEY\"" }, { "lang": "JavaScript", "label": "Node", "source": "const res = await fetch(`https://www.dropfans.io/api/external/payouts/summary`, {\n headers: {\n Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n },\n});\nconsole.log(await res.json());" }, { "lang": "Python", "source": "import os\nimport requests\n\nres = requests.get(\n \"https://www.dropfans.io/api/external/payouts/summary\",\n headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n)\nprint(res.json())" } ], "x-dropfans-docs": "https://www.dropfans.io/developers/reference/get-payout-summary", "x-dropfans-agency-permission": "canViewStats" } ``` --- Previous: [Send a test event](https://www.dropfans.io/developers/reference/test-webhook.md) · Next: [Payout history (paginated)](https://www.dropfans.io/developers/reference/list-payouts.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)