| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* With <code>Recipient</code> objects, you can transfer money from your Stripe |
| 9 |
* account to a third-party bank account or debit card. The API allows you to |
| 10 |
* create, delete, and update your recipients. You can retrieve individual |
| 11 |
* recipients as well as a list of all your recipients. |
| 12 |
* |
| 13 |
* <strong><code>Recipient</code> objects have been deprecated in favor of <a |
| 14 |
* href="https://stripe.com/docs/connect">Connect</a>, specifically Connect's much |
| 15 |
* more powerful <a href="https://stripe.com/docs/api#account">Account objects</a>. |
| 16 |
* Stripe accounts that don't already use recipients can no longer begin doing so. |
| 17 |
* Please use <code>Account</code> objects instead.</strong> |
| 18 |
* |
| 19 |
* @property string $id Unique identifier for the object. |
| 20 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 21 |
* @property null|\Stripe\BankAccount $active_account Hash describing the current account on the recipient, if there is one. |
| 22 |
* @property null|\Stripe\Collection<\Stripe\Card> $cards |
| 23 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 24 |
* @property null|string|\Stripe\Card $default_card The default card to use for creating transfers to this recipient. |
| 25 |
* @property null|string $description An arbitrary string attached to the object. Often useful for displaying to users. |
| 26 |
* @property null|string $email |
| 27 |
* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. |
| 28 |
* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format. |
| 29 |
* @property null|string|\Stripe\Account $migrated_to The ID of the <a href="https://stripe.com/docs/connect/custom-accounts">Custom account</a> 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. |
| 30 |
* @property null|string $name Full, legal name of the recipient. |
| 31 |
* @property string|\Stripe\Account $rolled_back_from |
| 32 |
* @property string $type Type of the recipient, one of <code>individual</code> or <code>corporation</code>. |
| 33 |
* @property bool $verified Whether the recipient has been verified. This field is non-standard, and maybe removed in the future |
| 34 |
*/ |
| 35 |
class Recipient extends ApiResource |
| 36 |
{ |
| 37 |
const OBJECT_NAME = 'recipient'; |
| 38 |
|
| 39 |
use ApiOperations\All; |
| 40 |
use ApiOperations\Create; |
| 41 |
use ApiOperations\Delete; |
| 42 |
use ApiOperations\Retrieve; |
| 43 |
use ApiOperations\Update; |
| 44 |
} |
| 45 |
|
