Recipient.php 2.7 KB

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