DropfansDropfans
Help CenterFAQDevelopersMini AppSign upLog in
Create a payout request for a creator
Get started
Dropfans APIMake your first callConnect a creator to your appTesting without a sandboxApply for API access
Concepts
Authentication & API keysApps & approvalAPI categoriesRate limitsErrorsPagination & batch limitsModeration & statusesMoney & unitsActing for a creator: agencies and CRMs
Guides
Sell a drop end-to-endUpload images, audio and videoLinks & Telegram deep linksPost to the For You feedEarnings & balanceBroadcast one drop to many fansCreator sign-up from your platformBuild your own CRM dashboard
Webhooks
Webhooks & polling
Build with AI
Build with AIAgent prompt
API v1 (OAuth apps)
OAuth appsAPI v1 overviewAPI v1 resource listAPI v1 webhooks
API reference
API reference overview
▶Account
GETGet the account for this API keyGETGet the profile for a creatorNewPATCHUpdate the profile for a creatorNewGETGet the timezone for a creatorPUTUpdate the timezone for a creatorGETGet the subscription tier for a creatorNewPUTUpdate the subscription tier for a creatorNewGETGet the payout balance for a creator
▶Agencies
GETGet creators and personas for your agencyNewPOSTCreate an AI persona for your agencyNewPATCHUpdate an AI persona for your agencyNewDELDelete an AI persona for your agency (retire)NewPOSTReactivate an AI persona for your agencyNewPOSTCreate a creator invite for your agencyNewGETGet invites for your agency (cursor-paginated)NewDELDelete an invite for your agency (revoke)NewDELRemove a creator from your agencyNewGETGet revenue stats for your agencyNewGETGet daily earnings per creator for your agency (cursor-paginated)New
▶Creators you act for
GETGet creators you can act for (cursor-paginated)NewGETGet a creator you can act forNew
▶Vault
GETGet vault items for a creator (page-paginated)POSTUpload a vault item for a creatorDELDelete a vault item for a creatorPATCHUpdate a vault item’s folder for a creatorPATCHUpdate a vault item’s tags for a creatorGETGet vault folders for a creatorPOSTCreate a vault folder for a creatorDELDelete a vault folder for a creatorPOSTStart a video upload for a creator (step 1 of 3)POSTComplete a video upload for a creator (step 3 of 3)POSTCheck video status for a creator (batch)POSTCreate a media upload for a creatorNewPUTUpload a media upload part for a creatorNewPOSTComplete a media upload for a creatorNewGETGet a media upload for a creatorNew
▶Drops
POSTCreate a drop for a creatorGETGet drops for a creator (cursor-paginated)NewGETGet a drop for a creatorNewPATCHUpdate a drop for a creatorNewDELDelete (archive) a drop for a creatorNewPOSTAttach blur previews to a drop for a creatorPOSTCheck drop sales for a creator (batch)GETGet paid orders for a creator (cursor-paginated)New
▶Posts
POSTCreate a post for a creatorGETGet posts for a creator (page-paginated)GETGet a post for a creatorDELDelete a post for a creator
▶Earnings
GETGet the earnings overview for a creatorGETGet the earnings summary for a creatorNewGETGet transactions for a creator (cursor-paginated)NewGETGet paid tips for a creator (cursor-paginated)New
▶Links
GETGet links for a creatorNewPOSTCreate a link for a creatorNew
▶Telegram (advanced)
GETGet Telegram notification settings for a creatorPUTUpdate Telegram notification settings for a creatorPOSTRegister a Telegram notification chat for a creator
▶CRM integrations
POSTCreate a creator account for your appNewGETGet accounts for your app (cursor-paginated)NewGETGet an account for your appNewPOSTCreate an ID-check link for an accountNewGETGet the webhook endpoint for your appNewPUTUpdate the webhook endpoint for your appNewDELDelete the webhook endpoint for your appNewPOSTRotate the webhook signing secret for your appNewPOSTSend a test webhook event for your appNewGETGet details for your appNewGETGet dashboard stats for your appNewGETGet sales for your app (cursor-paginated)NewGETGet connected accounts for your appNew
▶Payouts
GETGet the payout summary for a creatorNewGETGet payouts for a creator (cursor-paginated)NewGETGet a payout for a creatorNewGETGet payout methods for a creatorNewPOSTCreate a Paxum payout method for a creatorNewPATCHUpdate a payout method for a creatorNewDELDelete a payout method for a creatorNewGETGet the MassPay profile for a creatorNewPOSTCreate the MassPay profile for a creatorNewGETGet MassPay wallet activation for a creatorNewPOSTCreate a payout request for a creatorNewPOSTCancel a payout request for a creatorNew
Resources
ChangelogAPI terms & acceptable use
Developers/API reference/Create a payout request for a creator
API reference

Create a payout request for a creator

Request a payout of the account's **full** available balance — exactly what "Pay out funds" does in the dashboard.

View as MarkdownUpdated Oct 30, 2026
← Previous
Get MassPay wallet activation for a creator
Next →
Cancel a payout request for a creator

Questions? support@dropfans.io

On this page
  • Authentication
  • Request body
  • Responses
  • Errors
  • Rate limiting
  • Code samples

Let your fans show their appreciation.

Become a creatorSign up as a fan

Company

  • Blog
  • About
  • Help & FAQ
  • Availability
  • For Creators
  • Developers

Policy

  • Terms
  • Privacy
  • Refunds
  • DMCA
  • Complaints
  • USC 2257
  • AI Content
  • Cookies

Socials

Dropfans

© 2026 Dropfans. All rights reserved.

Dropfans is operated by KVIQVIEW AB, Reg. No. 559552-3852, Gamla Låssbyvägen 27, Gothenburg, Sweden.

POST/api/external/v1/payouts/requestsalso served at /api/external/payouts/requestsNew

Request a payout of the account's full available balance — exactly what "Pay out funds" does in the dashboard.

One request is created per side (creator, agency, affiliate, share) that has money and no open request; each is reviewed and paid on its own. There is no amount: partial payouts are not possible.

Payout requests are for Paxum only: the default payout method must be Paxum, and the request goes straight to processing until Dropfans pays it. A MassPay wallet is paid out with a wallet load instead, never a request (400 method_not_requestable).

Idempotency-Key header required (1–255 printable characters, e.g. a UUID per payout you intend). Sending the same key with the same body again returns the original requests (201, with Idempotent-Replayed: true) instead of a second payout; the same key with a different body is refused with 409 idempotency_conflict. Keys are scoped to the account and your app (or, for a personal key, that key), so another app can never replay or block yours. A second call with the same key while the first is still running gets 409 payout_busy; retry it and it replays the first one's answer. Retry network errors with the same key.

Checked in this order, each with its own code: ID check (kyc_required) → payouts enabled (payouts_disabled) → not a buyer account (consumer_account) → a default payout method (no_method) → the payout wallet activated if the method is a MassPay wallet (masspay_not_activated) → the minimum (below_minimum) → no open request (request_open) → no payout being sent (in_flight) → the default method is Paxum (method_not_requestable). GET /payouts/summary reports the same gates up front.

The key's own account only: X-Dropfans-Account is refused, and so is a key an agency minted for an account it manages (403 agency_key_not_allowed) — an agency can never request a payout for a creator it manages.

Needs the Payouts category and an app key

Authentication

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

Request body

Content type: application/json — Optional — an empty body is fine.

NameTypeRequiredDescription
notestring | nullOptionalA note for the Dropfans team, shown with the request.
Max length: 500
With a note
{
  "note": "October"
}

Responses

201The requests created (or, on a replay, the original ones).
NameTypeDescription
requestsPayout[]One payout request per side that had money and no open request (kind request).
Show child attributes
idstringId of the row. Unique across the three kinds — use it with GET /api/external/v1/payouts/{id}.
kindstringpayout: 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.
One of: payout, manual, request
statusstringRequests: 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.
One of: requested, approved, pending, processing, paid, failed, cancelled, rejected
amountCentsintegerInteger **cents**. What is paid out (negative only on a reversal row).
currencystringAlways "USD".
One of: USD
sidestringWhich 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).
sidesobjectThe amount split by side, integer cents. Adds up to amountCents.
Show child attributes
creatorCentsintegerCreator side, cents.
agencyCentsintegerAgency side, cents.
affiliateCentsintegerReferral commission, cents.
shareCentsintegerPartner shares, cents.
methodobject | nullThe destination frozen when the payout or request was made, masked. Null for manual payouts.
Show child attributes
typestringProvider method type.
One of: PAXUM_P2P, MASSPAY, BANK_SWIFT
labelstringDisplay 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.
notestring | nullRequests: the note sent with the request. Manual payouts: the note the admin recorded for the payee. Otherwise null.
failureMessagestring | nullWhy a failed payout failed, as reported by the provider. Null unless status is failed.
invoiceNumberinteger | nullPayout invoice number once the invoice exists. The invoice itself is in the dashboard.
requestIdstring | nullkind payout / manual: the request this payout fulfilled, if any.
payoutIdstring | nullkind request: the payout or manual payout that fulfilled it, if any.
createdAtstringWhen the payout was created or the request made. The list is ordered by this.
Format: date-time
initiatedAtstring | nullWhen the payout was sent to the provider.
Format: date-time
paidAtstring | nullWhen it was paid. Null unless status is paid (requests carry it on the fulfilling payout instead).
Format: date-time
failedAtstring | nullWhen it failed. Null unless status is failed.
Format: date-time
reversedAtstring | nullSet 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
reversalOfIdstring | nullSet on the negative row that reverses the payout with this id.
Example response
{
  "requests": [
    {
      "id": "clxpr0001request",
      "kind": "request",
      "status": "requested",
      "amountCents": 34210,
      "currency": "USD",
      "side": "creator",
      "sides": {
        "creatorCents": 34210,
        "agencyCents": 0,
        "affiliateCents": 0,
        "shareCents": 0
      },
      "method": {
        "type": "MASSPAY",
        "label": "Payout wallet · SWE"
      },
      "note": "October",
      "failureMessage": null,
      "invoiceNumber": null,
      "requestId": null,
      "payoutId": null,
      "createdAt": "2026-10-30T09:12:00.000Z",
      "initiatedAt": null,
      "paidAt": null,
      "failedAt": null,
      "reversedAt": null,
      "reversalOfId": null
    }
  ]
}

Errors

StatusBodyWhen
400{"error":"Send an Idempotency-Key header (a unique value per payout request, e.g. a UUID).","code":"idempotency_key_required"}No `Idempotency-Key` header (`invalid_idempotency_key` when it is malformed).
400{"error":"note must be at most 500 characters","code":"invalid_note"}`note` is not a string or too long.
400{"error":"Invalid JSON body"}The body is not valid JSON.
400{"error":"Add a payout method before requesting a payout.","code":"no_method"}No default payout method.
400{"error":"Activate your payout wallet before requesting a payout.","code":"masspay_not_activated"}The default method is a MassPay wallet the payee has not activated yet.
400{"error":"Payout requests are only for Paxum. Use Load wallet to pay out to your MassPay wallet.","code":"method_not_requestable"}The default payout method is not Paxum (a MassPay wallet is paid out with a wallet load).
400{"error":"Minimum payout is $20.00.","code":"below_minimum"}The available balance is below the account’s minimum (or not positive).
401{"error":"Unauthorized","code":"unauthorized"}Missing or invalid API key.
403{"error":"Verify your identity (KYC) before requesting a payout.","code":"kyc_required"}The account has not passed the ID check.
403{"error":"Payouts are not enabled on your account yet.","code":"payouts_disabled"}Dropfans has paused payouts for the account.
403{"error":"Payouts are not available for this account","code":"consumer_account"}A buyer account.
403{"error":"Payout requests need the account’s own key — a key an agency minted for a managed account cannot request or cancel payouts.","code":"agency_key_not_allowed"}The key was minted by an agency for an account it manages.
403{"error":"This endpoint needs a key bound to an app with the payouts API category enabled — personal keys cannot use it.","code":"app_key_required","category":"payouts"}A personal key (not bound to an app). Personal keys may read payouts, but not change them.
409{"error":"You already have a payout request awaiting review.","code":"request_open"}Every side with money already has an open request.
409{"error":"A payout is already in progress. Try again once it has settled.","code":"in_flight"}A payout is pending or processing.
409{"error":"Another payout operation is running for this account. Try again in a moment.","code":"payout_busy"}Another payout operation holds the account’s payout lock (e.g. a concurrent request). Retry with the same key.
409{"error":"This Idempotency-Key was already used with a different request body.","code":"idempotency_conflict"}The key was used before with another body.
400{"error":"This endpoint only acts as the key’s own account — send it without X-Dropfans-Account.","code":"account_header_not_allowed"}`X-Dropfans-Account` names another account. An agency can never request or cancel a payout for a creator it manages.
400{"error":"This endpoint acts as the key’s own account or app — call it without /creators/{creatorId}.","code":"creator_scope_not_allowed"}Called under /api/external/v1/creators/{creatorId}/ — this endpoint always acts as the key’s own account, agency or app.
403{"error":"This app does not have the payouts API category enabled. Contact support to enable it.","code":"api_category_disabled","category":"payouts"}Your app has the Payouts [API category](/developers/concepts/api-categories) switched off (the default for new apps).

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 -X POST "https://www.dropfans.io/api/external/v1/payouts/requests" \
  -H "Authorization: Bearer $DROPFANS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"note":"October"}'
import { randomUUID } from 'node:crypto';

// Keep the key with your record of this payout and reuse it on retries.
const idempotencyKey = randomUUID();
const res = await fetch('https://www.dropfans.io/api/external/v1/payouts/requests', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
    'Idempotency-Key': idempotencyKey,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ note: 'October' }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${res.status} ${data.code}: ${data.error}`);
console.log(data.requests);
import os, uuid, requests

# Keep the key with your record of this payout and reuse it on retries.
idempotency_key = str(uuid.uuid4())
res = requests.post(
    "https://www.dropfans.io/api/external/v1/payouts/requests",
    headers={
        "Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}",
        "Idempotency-Key": idempotency_key,
    },
    json={"note": "October"},
)
res.raise_for_status()
print(res.json()["requests"])

Payouts are an API category that is off for every app until we switch it on — ask support. Personal keys can read payouts but get 403 app_key_required here.