> ## 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/methods — Payout methods (masked)

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

- Source: https://www.dropfans.io/developers/reference/list-payout-methods
- Section: API reference
- OpenAPI: https://www.dropfans.io/developers/openapi.json

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

Add a Paxum method with [POST /payouts/methods](https://www.dropfans.io/developers/reference/create-payout-method.md), the MassPay wallet with [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md); 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

`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: <account id>` — 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 methods.

| Field | Type | Required | Description |
|---|---|---|---|
| `methods` | PayoutMethodSummary[] | yes | Default first, then newest first. |

```json
{
  "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

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

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

### Node

```javascript
const res = await fetch(`https://www.dropfans.io/api/external/payouts/methods`, {
  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/methods",
    headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
)
print(res.json())
```

## OpenAPI

```json
{
  "method": "GET",
  "path": "/api/external/payouts/methods",
  "operationId": "listPayoutMethods",
  "tags": [
    "payouts"
  ],
  "summary": "Payout methods (masked)",
  "description": "The account's payout methods, default first, with every destination masked.\n\nAdd a Paxum method with [POST /payouts/methods](https://www.dropfans.io/developers/reference/create-payout-method.md), the MassPay wallet with [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md); the creator can also manage them in the dashboard.\n\nNothing 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.",
  "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 methods.",
      "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": {
              "methods": {
                "type": "array",
                "items": {
                  "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"
                  ]
                },
                "description": "Default first, then newest first."
              }
            },
            "required": [
              "methods"
            ]
          },
          "example": {
            "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
              }
            ]
          }
        }
      }
    },
    "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/methods\" \\\n  -H \"Authorization: Bearer $DROPFANS_API_KEY\""
    },
    {
      "lang": "JavaScript",
      "label": "Node",
      "source": "const res = await fetch(`https://www.dropfans.io/api/external/payouts/methods`, {\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/methods\",\n    headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n)\nprint(res.json())"
    }
  ],
  "x-dropfans-docs": "https://www.dropfans.io/developers/reference/list-payout-methods",
  "x-dropfans-agency-permission": "canViewStats"
}
```

---

Previous: [One payout or payout request](https://www.dropfans.io/developers/reference/get-payout.md) · Next: [Add a Paxum payout method](https://www.dropfans.io/developers/reference/create-payout-method.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)