# Choose how one program pays the signed-in affiliate

Sets the payout method from those the program offers: a Stripe transfer, by hand, PayPal or a Wise file with bank details.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`PUT /api/v1/public/me/affiliates/id/payout-method`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Sets the payout method from those the program offers: a Stripe transfer, by hand, PayPal or a Wise file with bank details. Setting a PayPal email or bank details needs a recent sign-in (403 `reauth_required`), and a new destination either waits for a confirmation link or applies with a hold, as the app owner's policies say, with the account emailed. Refused with 422 when the method is not offered, PayPal is not open or the details are invalid.

## Request

| Field | Type   | Required | Constraints              | Description |
| ----- | ------ | -------- | ------------------------ | ----------- |
| `id`  | string | Yes      | matches `^[a-f0-9]{24}$` | -           |

Send the body as `application/json`.

| Field                     | Type           | Required | Constraints                                                  | Description |
| ------------------------- | -------------- | -------- | ------------------------------------------------------------ | ----------- |
| `method`                  | string         | Yes      | one of `"transfer"`, `"manual"`, `"paypal"`, `"wise_export"` | -           |
| `paypalEmail`             | string         | No       | at most 254 characters                                       | -           |
| `paypalEmailConfirm`      | string         | No       | at most 254 characters                                       | -           |
| `bank`                    | object         | No       | -                                                            | -           |
| `bank.holderName`         | string         | No       | 1 to 128 characters                                          | -           |
| `bank.currency`           | string         | No       | matches `^[a-zA-Z]{3}$`                                      | -           |
| `bank.receiverType`       | string         | No       | one of `"PRIVATE"`, `"BUSINESS"`                             | -           |
| `bank.iban`               | string or null | No       | at most 64 characters                                        | -           |
| `bank.bic`                | string or null | No       | at most 64 characters                                        | -           |
| `bank.accountNumber`      | string or null | No       | at most 64 characters                                        | -           |
| `bank.sortCode`           | string or null | No       | at most 64 characters                                        | -           |
| `bank.abartn`             | string or null | No       | at most 64 characters                                        | -           |
| `bank.accountType`        | string or null | No       | one of `"CHECKING"`, `"SAVINGS"`                             | -           |
| `bank.addressCountryCode` | string or null | No       | matches `^[a-zA-Z]{2}$`                                      | -           |
| `bank.addressCity`        | string or null | No       | at most 64 characters                                        | -           |
| `bank.addressFirstLine`   | string or null | No       | at most 128 characters                                       | -           |
| `bank.addressPostCode`    | string or null | No       | at most 64 characters                                        | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X PUT "https://api.console.buildbase.app/api/v1/public/me/affiliates/YOUR_ID/payout-method" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "transfer"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/affiliates/YOUR_ID/payout-method',
  {
    method: 'PUT',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      method: 'transfer',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import os

import requests

response = requests.put(
    "https://api.console.buildbase.app/api/v1/public/me/affiliates/YOUR_ID/payout-method",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "method": "transfer",
    },
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [All Me operations](/http-api/reference/me)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `me.affiliates.payoutMethod.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
