# PostRecipientsId

From **Stripe API**.

`POST /v1/recipients/{id}`

**Deprecated.**

<p>Updates the specified recipient by setting the values of the parameters passed.
Any parameters not provided will be left unchanged.</p>

<p>If you update the name or tax ID, the identity verification will automatically be rerun.
If you update the bank account, the bank account validation will automatically be rerun.</p>

## Parameters

### `id`

- Location: path
- Required: true
- Type: `string`
- maxLength: `5000`

## Request body

- Required: false
### `application/x-www-form-urlencoded`

- Type: `object`

```json
{"additionalProperties":false,"properties":{"bank_account":{"description":"A bank account to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details, with the options described below.","maxLength":5000,"type":"string","x-stripeBypassValidation":true},"card":{"description":"A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's debit card details, with the options described below. Passing `card` will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the [card creation API](https://stripe.com/docs/api#create_card). Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.","maxLength":5000,"type":"string","x-stripeBypassValidation":true},"default_card":{"description":"ID of the card to set as the recipient's new default for payouts.","maxLength":5000,"type":"string"},"description":{"description":"An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface.","maxLength":5000,"type":"string"},"email":{"description":"The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.","maxLength":5000,"type":"string"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."},"name":{"description":"The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name.","maxLength":5000,"type":"string"},"tax_id":{"description":"The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN.","maxLength":5000,"type":"string"}},"type":"object"}
```

## Security

### `basicAuth`

- Type: `http`
- Request header: `Authorization`
- Scheme: `basic`
Send credentials in the `Authorization` request header using the `Basic` scheme.

Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>

### `bearerAuth`

- Type: `http`
- Request header: `Authorization`
- Scheme: `bearer`
- Bearer format: `auth-scheme`
Send the token in the `Authorization` request header using the `Bearer` scheme.

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

## Responses

### `200`

Successful response.

### `application/json`

- Type: `object`

With `Recipient` objects, you can transfer money from your Stripe account to a
third-party bank account or debit card. The API allows you to create, delete,
and update your recipients. You can retrieve individual recipients as well as
a list of all your recipients.

**`Recipient` objects have been deprecated in favor of
[Connect](https://stripe.com/docs/connect), specifically Connect's much more powerful
[Account objects](https://stripe.com/docs/api#account). Stripe accounts that don't already use
recipients can no longer begin doing so. Please use `Account` objects
instead.**

```json
{"description":"With `Recipient` objects, you can transfer money from your Stripe account to a\nthird-party bank account or debit card. The API allows you to create, delete,\nand update your recipients. You can retrieve individual recipients as well as\na list of all your recipients.\n\n**`Recipient` objects have been deprecated in favor of\n[Connect](https://stripe.com/docs/connect), specifically Connect's much more powerful\n[Account objects](https://stripe.com/docs/api#account). Stripe accounts that don't already use\nrecipients can no longer begin doing so. Please use `Account` objects\ninstead.**","properties":{"active_account":{"anyOf":[{"$ref":"#/components/schemas/bank_account"}],"description":"Hash describing the current account on the recipient, if there is one.","nullable":true},"cards":{"nullable":true,"properties":{"data":{"items":{"$ref":"#/components/schemas/card"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"type":"string"}},"required":["data","has_more","object","url"],"title":"CardList","type":"object","x-expandableFields":["data"]},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"default_card":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/card"}],"description":"The default card to use for creating transfers to this recipient.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/card"}]}},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"email":{"maxLength":5000,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object"},"migrated_to":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/account"}],"description":"The ID of the [Custom account](https://stripe.com/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/account"}]}},"name":{"description":"Full, legal name of the recipient.","maxLength":5000,"nullable":true,"type":"string"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["recipient"],"type":"string"},"rolled_back_from":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/account"}],"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/account"}]}},"type":{"description":"Type of the recipient, one of `individual` or `corporation`.","maxLength":5000,"type":"string"}},"required":["created","id","livemode","metadata","object","type"],"title":"TransferRecipient","type":"object","x-expandableFields":["active_account","cards","default_card","migrated_to","rolled_back_from"],"x-resourceId":"recipient"}
```

### `default`

Error response.

### `application/json`

- Type: `object`

An error response from the Stripe API

```json
{"description":"An error response from the Stripe API","properties":{"error":{"$ref":"#/components/schemas/api_errors"}},"required":["error"],"type":"object"}
```

## Request examples

### cURL

```shell
curl --request POST \
  --url https://api.stripe.com/v1/recipients/{id} \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data '{
  "bank_account": "string",
  "card": "string",
  "default_card": "string",
  "description": "string",
  "email": "string",
  "expand": [
    "string"
  ],
  "metadata": "string",
  "name": "string",
  "tax_id": "string"
}'
```
