> ## 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/masspay/profile — Set up the MassPay wallet

> Set up the account's MassPay payout wallet from the same profile the dashboard's setup form collects, and make it the default payout method.

- Source: https://www.dropfans.io/developers/reference/setup-masspay-wallet
- Section: API reference
- OpenAPI: https://www.dropfans.io/developers/openapi.json

Set up the account's MassPay payout wallet from the same profile the dashboard's setup form collects, and make it the default payout method.

**Required:** `firstName`, `lastName`, `email`, `country`, `address1`, `city`, `stateProvince`, `postalCode`, plus `businessName` when `accountType` is `BUSINESS`. **Optional:** `middleName`, `mobileNumber`, `language`, `dateOfBirth`, `address2`. Enter everything as on the payee's government-issued ID. Every field is checked before anything is sent to MassPay; a refused profile answers 400 `invalid_profile` naming the first bad `field`, with all of them in `errors`.

- **No payee yet** → the payee is created at MassPay with the full profile (201).
- **Payee exists but lacks required details** (see `missingFields` on [GET /payouts/masspay/profile](https://www.dropfans.io/developers/reference/get-masspay-profile.md)) → the fields you send fill them in. `country`, `email` and `businessName` stay as MassPay has them; send at least the missing fields.
- **Payee complete** → the body is not needed; the wallet is (re)attached.

**Activation:** before the first payout to the wallet, the payee must open `activationUrl` once in a browser (a MassPay requirement). The link expires — get a fresh one from [GET /payouts/masspay/activation](https://www.dropfans.io/developers/reference/get-masspay-activation.md) when you send the payee there. Payout requests to a wallet that is not activated are refused (`masspay_not_activated`).

Safe to retry: there is one MassPay payee and one wallet per account. The key's own account only, after the ID check.

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

The payout profile. Optional when the payee already exists and is complete.

| Field | Type | Required | Description |
|---|---|---|---|
| `accountType` | `INDIVIDUAL` \\| `BUSINESS` |  | Who the payee is. `BUSINESS` makes `businessName` required; the person fields are then the authorized representative’s. |
| `businessName` | string |  | **Required when `accountType` is BUSINESS.** The company’s registered legal name. Its presence is what makes the payee a business account at MassPay; the person fields are then the authorized representative’s. Cannot be changed once set. |
| `firstName` | string | yes | As on the government-issued ID. |
| `middleName` | string |  | Optional. As on the ID. |
| `lastName` | string | yes | As on the ID. |
| `email` | string | yes | Must not be used by another MassPay account. |
| `mobileNumber` | string |  | Optional. With country code; 7–15 digits once spaces and symbols are removed. |
| `language` | string |  | Optional. ISO 639-1 code for MassPay’s e-mails and portal (default "en"). |
| `dateOfBirth` | string |  | Optional. YYYY-MM-DD, a real date; the payee must be at least 18. |
| `country` | string | yes | ISO 3166-1 alpha-3 country of residence. |
| `address1` | string | yes | Street address. |
| `address2` | string |  | Optional. Apartment, suite, c/o. |
| `city` | string | yes | City. |
| `stateProvince` | string | yes | State, province, county or region. |
| `postalCode` | string | yes | Postal / ZIP code. |

Example — An individual:

```json
{
  "accountType": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane@example.com",
  "country": "SWE",
  "address1": "Storgatan 1",
  "city": "Stockholm",
  "stateProvince": "Stockholm County",
  "postalCode": "111 22",
  "dateOfBirth": "1994-05-17",
  "language": "sv"
}
```

Example — Completing an existing payee:

```json
{
  "address1": "Storgatan 1",
  "city": "Stockholm",
  "stateProvince": "Stockholm County",
  "postalCode": "111 22"
}
```

## Responses

### 201

The wallet was attached (201 when the wallet method was created, 200 when an existing one was re-attached).

| Field | Type | Required | Description |
|---|---|---|---|
| `method` | PayoutMethodSummary | yes | The wallet method, now the default. |
| `activationUrl` | string \\| null |  | Where the payee activates the wallet (once, in a browser). Null when already activated. Expires. |
| `created` | boolean | yes | True when the MassPay payee was created by this call. |
| `completed` | boolean | yes | True when missing profile fields were filled in at MassPay by this call. |

```json
{
  "method": {
    "id": "clxpm0001method",
    "type": "MASSPAY",
    "isDefault": true,
    "nickname": null,
    "label": "Payout wallet · SWE",
    "holderType": "INDIVIDUAL",
    "createdAt": "2026-10-30T10:00:00.000Z",
    "paxum": null,
    "masspay": {
      "country": "SWE",
      "currency": null,
      "payerName": null,
      "activated": false
    },
    "bank": null
  },
  "activationUrl": "https://payee.masspay.io/activate/…",
  "created": true,
  "completed": false
}
```

## Errors

| Status | Body | When |
|---|---|---|
| 400 | `{"error":"City is required.","code":"invalid_profile","field":"city","errors":[{"field":"city","code":"required","message":"City is required."}]}` | A field is missing or invalid. Codes in `errors`: required, too_long, invalid_type, invalid_account_type, invalid_email, invalid_country, invalid_date_of_birth, under_18, invalid_mobile_number, invalid_language. |
| 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":"Could not determine your payout country. Contact support.","code":"no_country"}` | An existing payee has no usable country. Contact support. |
| 422 | `{"error":"This email is already used by another MassPay account. Enter a different email.","code":"masspay_email_in_use"}` | MassPay refused the profile (`masspay_rejected` with MassPay’s reason for other refusals). |
| 502 | `{"error":"Could not read your MassPay profile. Try again in a moment.","code":"masspay_unavailable"}` | MassPay did not answer. Retry. |
| 503 | `{"error":"MassPay is not available right now.","code":"not_configured"}` | MassPay payouts are switched off on this environment. |
| 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/masspay/profile" \
  -H "Authorization: Bearer $DROPFANS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountType": "INDIVIDUAL",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane@example.com",
  "country": "SWE",
  "address1": "Storgatan 1",
  "city": "Stockholm",
  "stateProvince": "Stockholm County",
  "postalCode": "111 22",
  "dateOfBirth": "1994-05-17",
  "language": "sv"
}'
```

### Node

```javascript
const res = await fetch(`https://www.dropfans.io/api/external/payouts/masspay/profile`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accountType": "INDIVIDUAL",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com",
    "country": "SWE",
    "address1": "Storgatan 1",
    "city": "Stockholm",
    "stateProvince": "Stockholm County",
    "postalCode": "111 22",
    "dateOfBirth": "1994-05-17",
    "language": "sv"
  }),
});
console.log(await res.json());
```

### Python

```python
import os
import requests

res = requests.post(
    "https://www.dropfans.io/api/external/payouts/masspay/profile",
    headers={"Authorization": f"Bearer {os.environ['DROPFANS_API_KEY']}"},
    json={
        "accountType": "INDIVIDUAL",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com",
        "country": "SWE",
        "address1": "Storgatan 1",
        "city": "Stockholm",
        "stateProvince": "Stockholm County",
        "postalCode": "111 22",
        "dateOfBirth": "1994-05-17",
        "language": "sv",
    },
)
print(res.json())
```

## OpenAPI

```json
{
  "method": "POST",
  "path": "/api/external/payouts/masspay/profile",
  "operationId": "setupMasspayWallet",
  "tags": [
    "payouts"
  ],
  "summary": "Set up the MassPay wallet",
  "description": "Set up the account's MassPay payout wallet from the same profile the dashboard's setup form collects, and make it the default payout method.\n\n**Required:** `firstName`, `lastName`, `email`, `country`, `address1`, `city`, `stateProvince`, `postalCode`, plus `businessName` when `accountType` is `BUSINESS`. **Optional:** `middleName`, `mobileNumber`, `language`, `dateOfBirth`, `address2`. Enter everything as on the payee's government-issued ID. Every field is checked before anything is sent to MassPay; a refused profile answers 400 `invalid_profile` naming the first bad `field`, with all of them in `errors`.\n\n- **No payee yet** → the payee is created at MassPay with the full profile (201).\n- **Payee exists but lacks required details** (see `missingFields` on [GET /payouts/masspay/profile](https://www.dropfans.io/developers/reference/get-masspay-profile.md)) → the fields you send fill them in. `country`, `email` and `businessName` stay as MassPay has them; send at least the missing fields.\n- **Payee complete** → the body is not needed; the wallet is (re)attached.\n\n**Activation:** before the first payout to the wallet, the payee must open `activationUrl` once in a browser (a MassPay requirement). The link expires — get a fresh one from [GET /payouts/masspay/activation](https://www.dropfans.io/developers/reference/get-masspay-activation.md) when you send the payee there. Payout requests to a wallet that is not activated are refused (`masspay_not_activated`).\n\nSafe to retry: there is one MassPay payee and one wallet per account. The key's own account only, after the ID check.\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": "The payout profile. Optional when the payee already exists and is complete.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "accountType": {
              "type": "string",
              "description": "Who the payee is. `BUSINESS` makes `businessName` required; the person fields are then the authorized representative’s.",
              "enum": [
                "INDIVIDUAL",
                "BUSINESS"
              ],
              "default": "INDIVIDUAL"
            },
            "businessName": {
              "type": "string",
              "description": "**Required when `accountType` is BUSINESS.** The company’s registered legal name. Its presence is what makes the payee a business account at MassPay; the person fields are then the authorized representative’s. Cannot be changed once set.",
              "example": "Jane Doe Media AB",
              "maxLength": 150
            },
            "firstName": {
              "type": "string",
              "description": "As on the government-issued ID.",
              "example": "Jane",
              "maxLength": 100
            },
            "middleName": {
              "type": "string",
              "description": "Optional. As on the ID.",
              "maxLength": 100
            },
            "lastName": {
              "type": "string",
              "description": "As on the ID.",
              "example": "Doe",
              "maxLength": 100
            },
            "email": {
              "type": "string",
              "description": "Must not be used by another MassPay account.",
              "format": "email",
              "example": "jane@example.com",
              "maxLength": 254
            },
            "mobileNumber": {
              "type": "string",
              "description": "Optional. With country code; 7–15 digits once spaces and symbols are removed.",
              "example": "+46 70 123 45 67",
              "maxLength": 32
            },
            "language": {
              "type": "string",
              "description": "Optional. ISO 639-1 code for MassPay’s e-mails and portal (default \"en\").",
              "example": "en",
              "maxLength": 2
            },
            "dateOfBirth": {
              "type": "string",
              "description": "Optional. YYYY-MM-DD, a real date; the payee must be at least 18.",
              "format": "date",
              "example": "1994-05-17",
              "maxLength": 10
            },
            "country": {
              "type": "string",
              "description": "ISO 3166-1 alpha-3 country of residence.",
              "example": "SWE",
              "maxLength": 3
            },
            "address1": {
              "type": "string",
              "description": "Street address.",
              "example": "Storgatan 1",
              "maxLength": 150
            },
            "address2": {
              "type": "string",
              "description": "Optional. Apartment, suite, c/o.",
              "maxLength": 150
            },
            "city": {
              "type": "string",
              "description": "City.",
              "example": "Stockholm",
              "maxLength": 100
            },
            "stateProvince": {
              "type": "string",
              "description": "State, province, county or region.",
              "example": "Stockholm County",
              "maxLength": 100
            },
            "postalCode": {
              "type": "string",
              "description": "Postal / ZIP code.",
              "example": "111 22",
              "maxLength": 20
            }
          },
          "required": [
            "firstName",
            "lastName",
            "email",
            "country",
            "address1",
            "city",
            "stateProvince",
            "postalCode"
          ]
        },
        "examples": {
          "individual": {
            "summary": "An individual",
            "value": {
              "accountType": "INDIVIDUAL",
              "firstName": "Jane",
              "lastName": "Doe",
              "email": "jane@example.com",
              "country": "SWE",
              "address1": "Storgatan 1",
              "city": "Stockholm",
              "stateProvince": "Stockholm County",
              "postalCode": "111 22",
              "dateOfBirth": "1994-05-17",
              "language": "sv"
            }
          },
          "complete": {
            "summary": "Completing an existing payee",
            "value": {
              "address1": "Storgatan 1",
              "city": "Stockholm",
              "stateProvince": "Stockholm County",
              "postalCode": "111 22"
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "The wallet was attached (201 when the wallet method was created, 200 when an existing one was re-attached).",
      "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": {
              "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"
                ]
              },
              "activationUrl": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Where the payee activates the wallet (once, in a browser). Null when already activated. Expires.",
                "format": "uri"
              },
              "created": {
                "type": "boolean",
                "description": "True when the MassPay payee was created by this call."
              },
              "completed": {
                "type": "boolean",
                "description": "True when missing profile fields were filled in at MassPay by this call."
              }
            },
            "required": [
              "method",
              "created",
              "completed"
            ]
          },
          "example": {
            "method": {
              "id": "clxpm0001method",
              "type": "MASSPAY",
              "isDefault": true,
              "nickname": null,
              "label": "Payout wallet · SWE",
              "holderType": "INDIVIDUAL",
              "createdAt": "2026-10-30T10:00:00.000Z",
              "paxum": null,
              "masspay": {
                "country": "SWE",
                "currency": null,
                "payerName": null,
                "activated": false
              },
              "bank": null
            },
            "activationUrl": "https://payee.masspay.io/activate/…",
            "created": true,
            "completed": false
          }
        }
      }
    },
    "400": {
      "description": "A field is missing or invalid. Codes in `errors`: required, too_long, invalid_type, invalid_account_type, invalid_email, invalid_country, invalid_date_of_birth, under_18, invalid_mobile_number, invalid_language. 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 naming the offending field and word.",
                "example": "Field \"name\" contains a prohibited word: \"…\""
              },
              "field": {
                "type": "string",
                "description": "Which request field tripped the filter (\"name\" or \"description\")."
              },
              "matchedWord": {
                "type": "string",
                "description": "The prohibited word."
              }
            },
            "required": [
              "error",
              "field",
              "matchedWord"
            ]
          },
          "example": {
            "error": "City is required.",
            "code": "invalid_profile",
            "field": "city",
            "errors": [
              {
                "field": "city",
                "code": "required",
                "message": "City is 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: 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": "An existing payee has no usable country. Contact support.",
      "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 determine your payout country. Contact support.",
            "code": "no_country"
          }
        }
      }
    },
    "422": {
      "description": "MassPay refused the profile (`masspay_rejected` with MassPay’s reason for other refusals).",
      "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 email is already used by another MassPay account. Enter a different email.",
            "code": "masspay_email_in_use"
          }
        }
      }
    },
    "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": "MassPay did not answer. 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 read your MassPay profile. Try again in a moment.",
            "code": "masspay_unavailable"
          }
        }
      }
    },
    "503": {
      "description": "MassPay payouts are switched off on this environment.",
      "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": "MassPay is not available right now.",
            "code": "not_configured"
          }
        }
      }
    }
  },
  "x-codeSamples": [
    {
      "lang": "cURL",
      "label": "curl",
      "source": "curl -X POST \"https://www.dropfans.io/api/external/payouts/masspay/profile\" \\\n  -H \"Authorization: Bearer $DROPFANS_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"accountType\": \"INDIVIDUAL\",\n  \"firstName\": \"Jane\",\n  \"lastName\": \"Doe\",\n  \"email\": \"jane@example.com\",\n  \"country\": \"SWE\",\n  \"address1\": \"Storgatan 1\",\n  \"city\": \"Stockholm\",\n  \"stateProvince\": \"Stockholm County\",\n  \"postalCode\": \"111 22\",\n  \"dateOfBirth\": \"1994-05-17\",\n  \"language\": \"sv\"\n}'"
    },
    {
      "lang": "JavaScript",
      "label": "Node",
      "source": "const res = await fetch(`https://www.dropfans.io/api/external/payouts/masspay/profile`, {\n  method: 'POST',\n  headers: {\n    Authorization: `Bearer ${process.env.DROPFANS_API_KEY}`,\n    'Content-Type': 'application/json',\n  },\n  body: JSON.stringify({\n    \"accountType\": \"INDIVIDUAL\",\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"email\": \"jane@example.com\",\n    \"country\": \"SWE\",\n    \"address1\": \"Storgatan 1\",\n    \"city\": \"Stockholm\",\n    \"stateProvince\": \"Stockholm County\",\n    \"postalCode\": \"111 22\",\n    \"dateOfBirth\": \"1994-05-17\",\n    \"language\": \"sv\"\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/masspay/profile\",\n    headers={\"Authorization\": f\"Bearer {os.environ['DROPFANS_API_KEY']}\"},\n    json={\n        \"accountType\": \"INDIVIDUAL\",\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\",\n        \"email\": \"jane@example.com\",\n        \"country\": \"SWE\",\n        \"address1\": \"Storgatan 1\",\n        \"city\": \"Stockholm\",\n        \"stateProvince\": \"Stockholm County\",\n        \"postalCode\": \"111 22\",\n        \"dateOfBirth\": \"1994-05-17\",\n        \"language\": \"sv\",\n    },\n)\nprint(res.json())"
    }
  ],
  "x-dropfans-docs": "https://www.dropfans.io/developers/reference/setup-masspay-wallet"
}
```

---

Previous: [MassPay payout profile](https://www.dropfans.io/developers/reference/get-masspay-profile.md) · Next: [MassPay wallet activation](https://www.dropfans.io/developers/reference/get-masspay-activation.md) · All pages: [llms.txt](https://www.dropfans.io/developers/llms.txt)