> ## 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. # POST /api/external/payouts/requests — Request a payout > Request a payout of the account's **full** available balance — exactly what "Pay out funds" does in the dashboard. - Source: https://www.dropfans.io/developers/reference/create-payout-request - Section: API reference - OpenAPI: https://www.dropfans.io/developers/openapi.json 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. **`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`). [GET /payouts/summary](https://www.dropfans.io/developers/reference/get-payout-summary.md) 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. > [!NOTE] Dropfans-operated integrations only, for now > At launch this endpoint answers 403 `first_party_only` to every other app. The read endpoints of this group are open to every key. ## 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"}`. ## Request body (application/json) Optional — an empty body is fine. | Field | Type | Required | Description | |---|---|---|---| | `note` | string \\| null | | A note for the Dropfans team, shown with the request. | Example — With a note: ```json { "note": "October" } ``` ## Responses ### 201 The requests created (or, on a replay, the original ones). | Field | Type | Required | Description | |---|---|---|---| | `requests` | Payout[] | yes | One payout request per side that had money and no open request (kind `request`). | ```json { "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 | Status | Body | When | |---|---|---| | 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":"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 is only available to Dropfans-operated integrations.","code":"first_party_only"}` | During launch, payout requests are open to Dropfans-operated integrations only. | | 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. | ## 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 -X POST "https://www.dropfans.io/api/external/payouts/requests" \ -H "Authorization: Bearer $DROPFANS_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{"note":"October"}' ``` ### Node ```javascript 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/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); ``` ### Python ```python 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/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"]) ``` ## OpenAPI ```json { "method": "POST", "path": "/api/external/payouts/requests", "operationId": "createPayoutRequest", "tags": [ "payouts" ], "summary": "Request a payout", "description": "Request a payout of the account's **full** available balance — exactly what \"Pay out funds\" does in the dashboard.\n\nOne 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.\n\n**`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.\n\nChecked 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`). [GET /payouts/summary](https://www.dropfans.io/developers/reference/get-payout-summary.md) reports the same gates up front.\n\nThe 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.\n\n> [!NOTE] Dropfans-operated integrations only, for now\n> At launch this endpoint answers 403 `first_party_only` to every other app. The read endpoints of this group are open to every key.", "requestBody": { "required": true, "description": "Optional — an empty body is fine.", "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": [ "string", "null" ], "description": "A note for the Dropfans team, shown with the request.", "maxLength": 500 } } }, "examples": { "withNote": { "summary": "With a note", "value": { "note": "October" } } } } } }, "responses": { "201": { "description": "The requests created (or, on a replay, the original ones).", "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" } }, "Idempotent-Replayed": { "description": "`true` when this answers a repeated Idempotency-Key.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "type": "array", "items": { "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" ] }, "description": "One payout request per side that had money and no open request (kind `request`)." } }, "required": [ "requests" ] }, "example": { "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 } ] } } } }, "400": { "description": "No `Idempotency-Key` header (`invalid_idempotency_key` when it is malformed). Also: `note` is not a string or too long. Also: The body is not valid JSON. Also: No default payout method. Also: The default method is a MassPay wallet the payee has not activated yet. Also: The available balance is below the account’s minimum (or not positive). Also: `X-Dropfans-Account` names another account. An agency can never request or cancel a payout for a creator it manages.", "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": "Send an Idempotency-Key header (a unique value per payout request, e.g. a UUID).", "code": "idempotency_key_required" } } } }, "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": "The account has not passed the ID check. Also: Dropfans has paused payouts for the account. Also: A buyer account. Also: The key was minted by an agency for an account it manages. Also: During launch, payout requests are open to Dropfans-operated integrations only.", "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": "Verify your identity (KYC) before requesting a payout.", "code": "kyc_required" } } } }, "409": { "description": "Every side with money already has an open request. Also: A payout is pending or processing. Also: Another payout operation holds the account’s payout lock (e.g. a concurrent request). Retry with the same key. Also: The key was used before with another body.", "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": "You already have a payout request awaiting review.", "code": "request_open" } } } }, "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 -X POST \"https://www.dropfans.io/api/external/payouts/requests\" \\\n -H \"Authorization: Bearer $DROPFANS_API_KEY\" \\\n -H \"Idempotency-Key: $(uuidgen)\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"note\":\"October\"}'" }, { "lang": "JavaScript", "label": "Node", "source": "import { randomUUID } from 'node:crypto';\n\n// Keep the key with your record of this payout and reuse it on retries.\nconst idempotencyKey = randomUUID();\nconst res = await fetch('https://www.dropfans.io/api/external/payouts/requests', {\n method: 'POST',\n headers: {\n Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n 'Idempotency-Key': idempotencyKey,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ note: 'October' }),\n});\nconst data = await res.json();\nif (!res.ok) throw new Error(`${res.status} ${data.code}: ${data.error}`);\nconsole.log(data.requests);" }, { "lang": "Python", "source": "import os, uuid, requests\n\n# Keep the key with your record of this payout and reuse it on retries.\nidempotency_key = str(uuid.uuid4())\nres = requests.post(\n \"https://www.dropfans.io/api/external/payouts/requests\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\",\n \"Idempotency-Key\": idempotency_key,\n },\n json={\"note\": \"October\"},\n)\nres.raise_for_status()\nprint(res.json()[\"requests\"])" } ], "x-dropfans-docs": "https://www.dropfans.io/developers/reference/create-payout-request" } ``` --- Previous: [MassPay wallet activation](https://www.dropfans.io/developers/reference/get-masspay-activation.md) · Next: [Cancel a payout request](https://www.dropfans.io/developers/reference/cancel-payout-request.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)