Payout methods (masked)
API reference

Payout methods (masked)

The account's payout methods, default first, with every destination masked.

View as MarkdownUpdated Oct 30, 2026
GET/api/external/payouts/methodsNew

The account's payout methods, default first, with every destination masked.

Add a Paxum method with POST /payouts/methods, the MassPay wallet with POST /payouts/masspay/profile; the creator can also manage them in the dashboard.

Nothing that moves money is returned: the Paxum e-mail is masked (j***@example.com), a bank account shows its last 4 characters only, and MassPay tokens are never included.

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

200The methods.
NameTypeDescription
methodsPayoutMethodSummary[]Default first, then newest first.
Show child attributes
idstringPayout method id.
typestringProvider method type.
One of: PAXUM_P2P, MASSPAY, BANK_SWIFT
isDefaultbooleanTrue for the method payouts go to.
nicknamestring | nullThe creator’s own label for it.
labelstringDisplay label, masked (see Payout.method.label).
holderTypestring | nullWhether it was set up for the person or the company.
One of: INDIVIDUAL, BUSINESS
createdAtstringWhen the method was added.
Format: date-time
paxumobject | nullPAXUM_P2P only.
Show child attributes
emailstring | nullMasked Paxum e-mail, e.g. "j***@example.com".
lookupStatusstring | nullWhether the e-mail is a live Paxum account: active, inactive, not_found, unconfigured.
verificationStatusstring | nullPaxum identity match against the ID check: PENDING, COMPLETED, MISMATCH, UNAVAILABLE.
masspayobject | nullMASSPAY (payout wallet) only.
Show child attributes
countrystring | nullISO 3166-1 alpha-3 country.
currencystring | nullPayout currency (ISO 4217), when chosen.
payerNamestring | nullPayout option name, when chosen.
activatedbooleanTrue once the payee finished the wallet activation. Payout requests to a wallet need it.
bankobject | nullBANK_SWIFT only.
Show child attributes
last4string | nullLast 4 characters of the account number. The full IBAN / SWIFT is never returned.
countrystring | nullBank country (ISO alpha-2).
bankNamestring | nullBank name.
Example response
{
  "methods": [
    {
      "id": "clxpm0001method",
      "type": "PAXUM_P2P",
      "isDefault": true,
      "nickname": null,
      "label": "Paxum · j***@example.com",
      "holderType": "INDIVIDUAL",
      "createdAt": "2026-09-02T10:00:00.000Z",
      "paxum": {
        "email": "j***@example.com",
        "lookupStatus": "active",
        "verificationStatus": "COMPLETED"
      },
      "masspay": null,
      "bank": null
    }
  ]
}

Errors

StatusBodyWhen
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.

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/payouts/methods" \
  -H "Authorization: Bearer $DROPFANS_API_KEY"

Questions? [email protected]