> ## 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/methods — Add a Paxum payout method

> Add a Paxum account as a payout method — what "Add Paxum" does in the dashboard, with a stricter e-mail check.

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

Add a Paxum account as a payout method — what "Add Paxum" does in the dashboard, with a stricter e-mail check.

The e-mail is looked up at Paxum and must be an **active** Paxum account: unknown or inactive accounts are refused with 422 `paxum_account_not_active` (the dashboard shows that on the card; an integration has nobody to show it to). If Paxum cannot be reached the answer is 502 `paxum_unavailable` — retry.

**Safe to retry, no `Idempotency-Key` needed:** adding an e-mail the account already has (case-insensitive) returns that existing method with 200 and `Idempotent-Replayed: true` instead of a duplicate; `nickname` / `isDefault` are then not applied (use PATCH).

`isDefault: true` makes it the method payouts go to. A MassPay wallet is set up with [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md) instead.

The key's own account only (`X-Dropfans-Account` and agency-minted keys are refused) and only after the ID check (403 `kyc_required`).

> [!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)

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | `PAXUM_P2P` | yes | The method type. Only `PAXUM_P2P` is created here. |
| `paxumEmail` | string | yes | The e-mail of the creator’s Paxum account. Never returned unmasked. |
| `nickname` | string \\| null |  | The creator’s own label, shown instead of the masked e-mail. |
| `isDefault` | boolean |  | Make it the default payout method. |

Example — Paxum as the default method:

```json
{
  "type": "PAXUM_P2P",
  "paxumEmail": "jane@example.com",
  "nickname": "Main Paxum",
  "isDefault": true
}
```

## Responses

### 201

The method was added (200 with `Idempotent-Replayed: true` when the account already had this e-mail).

| Field | Type | Required | Description |
|---|---|---|---|
| `method` | PayoutMethodSummary | yes | The method, masked. |

```json
{
  "method": {
    "id": "clxpm0002method",
    "type": "PAXUM_P2P",
    "isDefault": true,
    "nickname": "Main Paxum",
    "label": "Main Paxum",
    "holderType": "INDIVIDUAL",
    "createdAt": "2026-10-30T10:00:00.000Z",
    "paxum": {
      "email": "j***@example.com",
      "lookupStatus": "active",
      "verificationStatus": null
    },
    "masspay": null,
    "bank": null
  }
}
```

## Errors

| Status | Body | When |
|---|---|---|
| 400 | `{"error":"paxumEmail is not a valid email","code":"invalid_paxum_email"}` | `paxumEmail` missing or not an e-mail. |
| 400 | `{"error":"type must be \"PAXUM_P2P\".","code":"unsupported_type"}` | `type` missing or another type (MASSPAY: use POST /payouts/masspay/profile). |
| 400 | `{"error":"Unknown field: iban. Allowed: type, paxumEmail, nickname, isDefault.","code":"unknown_field"}` | A field that is not in the table (`invalid_nickname` / `invalid_is_default` for a wrong type or length). |
| 400 | `{"error":"Invalid JSON body"}` | The body is not valid JSON (`invalid_body` when it is not an object). |
| 401 | `{"error":"Unauthorized","code":"unauthorized"}` | Missing or invalid API key. |
| 403 | `{"error":"Verify your identity (KYC) before setting up payouts.","code":"kyc_required"}` | The account has not passed the ID check. |
| 403 | `{"error":"Payout methods need the account’s own key — a key an agency minted for a managed account cannot read or change where payouts go.","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-method endpoints are open to Dropfans-operated integrations only. |
| 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. Retry. |
| 422 | `{"error":"No Paxum account uses this e-mail. Check it, or create the Paxum account first.","code":"paxum_account_not_active","lookupStatus":"not_found"}` | The e-mail is not an active Paxum account (`lookupStatus`: `not_found` or `inactive`). |
| 502 | `{"error":"Could not reach Paxum to check the e-mail. Try again in a moment.","code":"paxum_unavailable"}` | The Paxum lookup failed. Retry. |
| 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 change where a creator it manages is paid. |

## 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/methods" \
  -H "Authorization: Bearer $DROPFANS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "PAXUM_P2P",
  "paxumEmail": "jane@example.com",
  "nickname": "Main Paxum",
  "isDefault": true
}'
```

### Node

```javascript
const res = await fetch(`https://www.dropfans.io/api/external/payouts/methods`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "PAXUM_P2P",
    "paxumEmail": "jane@example.com",
    "nickname": "Main Paxum",
    "isDefault": true
  }),
});
console.log(await res.json());
```

### Python

```python
import os
import requests

res = requests.post(
    "https://www.dropfans.io/api/external/payouts/methods",
    headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
    json={
        "type": "PAXUM_P2P",
        "paxumEmail": "jane@example.com",
        "nickname": "Main Paxum",
        "isDefault": True,
    },
)
print(res.json())
```

## OpenAPI

```json
{
  "method": "POST",
  "path": "/api/external/payouts/methods",
  "operationId": "createPayoutMethod",
  "tags": [
    "payouts"
  ],
  "summary": "Add a Paxum payout method",
  "description": "Add a Paxum account as a payout method — what \"Add Paxum\" does in the dashboard, with a stricter e-mail check.\n\nThe e-mail is looked up at Paxum and must be an **active** Paxum account: unknown or inactive accounts are refused with 422 `paxum_account_not_active` (the dashboard shows that on the card; an integration has nobody to show it to). If Paxum cannot be reached the answer is 502 `paxum_unavailable` — retry.\n\n**Safe to retry, no `Idempotency-Key` needed:** adding an e-mail the account already has (case-insensitive) returns that existing method with 200 and `Idempotent-Replayed: true` instead of a duplicate; `nickname` / `isDefault` are then not applied (use PATCH).\n\n`isDefault: true` makes it the method payouts go to. A MassPay wallet is set up with [POST /payouts/masspay/profile](https://www.dropfans.io/developers/reference/setup-masspay-wallet.md) instead.\n\nThe key's own account only (`X-Dropfans-Account` and agency-minted keys are refused) and only after the ID check (403 `kyc_required`).\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,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "The method type. Only `PAXUM_P2P` is created here.",
              "enum": [
                "PAXUM_P2P"
              ]
            },
            "paxumEmail": {
              "type": "string",
              "description": "The e-mail of the creator’s Paxum account. Never returned unmasked.",
              "format": "email",
              "example": "jane@example.com",
              "maxLength": 254
            },
            "nickname": {
              "type": [
                "string",
                "null"
              ],
              "description": "The creator’s own label, shown instead of the masked e-mail.",
              "maxLength": 100
            },
            "isDefault": {
              "type": "boolean",
              "description": "Make it the default payout method.",
              "default": false
            }
          },
          "required": [
            "type",
            "paxumEmail"
          ]
        },
        "examples": {
          "paxum": {
            "summary": "Paxum as the default method",
            "value": {
              "type": "PAXUM_P2P",
              "paxumEmail": "jane@example.com",
              "nickname": "Main Paxum",
              "isDefault": true
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "The method was added (200 with `Idempotent-Replayed: true` when the account already had this e-mail).",
      "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 the method already existed (status 200).",
          "schema": {
            "type": "integer"
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "method": {
                "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"
                ]
              }
            },
            "required": [
              "method"
            ]
          },
          "example": {
            "method": {
              "id": "clxpm0002method",
              "type": "PAXUM_P2P",
              "isDefault": true,
              "nickname": "Main Paxum",
              "label": "Main Paxum",
              "holderType": "INDIVIDUAL",
              "createdAt": "2026-10-30T10:00:00.000Z",
              "paxum": {
                "email": "j***@example.com",
                "lookupStatus": "active",
                "verificationStatus": null
              },
              "masspay": null,
              "bank": null
            }
          }
        }
      }
    },
    "400": {
      "description": "`paxumEmail` missing or not an e-mail. Also: `type` missing or another type (MASSPAY: use POST /payouts/masspay/profile). Also: A field that is not in the table (`invalid_nickname` / `invalid_is_default` for a wrong type or length). Also: The body is not valid JSON (`invalid_body` when it is not an object). Also: `X-Dropfans-Account` names another account. An agency can never change where a creator it manages is paid.",
      "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": "paxumEmail is not a valid email",
            "code": "invalid_paxum_email"
          }
        }
      }
    },
    "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: The key was minted by an agency for an account it manages. Also: During launch, payout-method endpoints 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 setting up payouts.",
            "code": "kyc_required"
          }
        }
      }
    },
    "409": {
      "description": "Another payout operation holds the account’s payout lock. 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"
          }
        }
      },
      "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": "Another payout operation is running for this account. Try again in a moment.",
            "code": "payout_busy"
          }
        }
      }
    },
    "422": {
      "description": "The e-mail is not an active Paxum account (`lookupStatus`: `not_found` or `inactive`).",
      "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": "No Paxum account uses this e-mail. Check it, or create the Paxum account first.",
            "code": "paxum_account_not_active",
            "lookupStatus": "not_found"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "502": {
      "description": "The Paxum lookup failed. 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"
          }
        }
      },
      "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": "Could not reach Paxum to check the e-mail. Try again in a moment.",
            "code": "paxum_unavailable"
          }
        }
      }
    }
  },
  "x-codeSamples": [
    {
      "lang": "cURL",
      "label": "curl",
      "source": "curl -X POST \"https://www.dropfans.io/api/external/payouts/methods\" \\\n  -H \"Authorization: Bearer $DROPFANS_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"type\": \"PAXUM_P2P\",\n  \"paxumEmail\": \"jane@example.com\",\n  \"nickname\": \"Main Paxum\",\n  \"isDefault\": true\n}'"
    },
    {
      "lang": "JavaScript",
      "label": "Node",
      "source": "const res = await fetch(`https://www.dropfans.io/api/external/payouts/methods`, {\n  method: 'POST',\n  headers: {\n    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n    'Content-Type': 'application/json',\n  },\n  body: JSON.stringify({\n    \"type\": \"PAXUM_P2P\",\n    \"paxumEmail\": \"jane@example.com\",\n    \"nickname\": \"Main Paxum\",\n    \"isDefault\": true\n  }),\n});\nconsole.log(await res.json());"
    },
    {
      "lang": "Python",
      "source": "import os\nimport requests\n\nres = requests.post(\n    \"https://www.dropfans.io/api/external/payouts/methods\",\n    headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n    json={\n        \"type\": \"PAXUM_P2P\",\n        \"paxumEmail\": \"jane@example.com\",\n        \"nickname\": \"Main Paxum\",\n        \"isDefault\": True,\n    },\n)\nprint(res.json())"
    }
  ],
  "x-dropfans-docs": "https://www.dropfans.io/developers/reference/create-payout-method"
}
```

---

Previous: [Payout methods (masked)](https://www.dropfans.io/developers/reference/list-payout-methods.md) · Next: [Change a payout method](https://www.dropfans.io/developers/reference/update-payout-method.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)