wp-user-avatar
/
third-party
/
vendor
/
stripe
/
stripe-php
/
lib
/
FinancialConnections
/
Account.php
wp-user-avatar
/
third-party
/
vendor
/
stripe
/
stripe-php
/
lib
/
FinancialConnections
Last commit date
Account.php
2 months ago
AccountOwner.php
2 months ago
AccountOwnership.php
2 months ago
Session.php
2 months ago
Transaction.php
2 months ago
Account.php
155 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\FinancialConnections; |
| 5 | |
| 6 | /** |
| 7 | * A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. |
| 8 | * |
| 9 | * @property string $id Unique identifier for the object. |
| 10 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 11 | * @property null|\Stripe\StripeObject $account_holder The account holder that this account belongs to. |
| 12 | * @property null|\Stripe\StripeObject $balance The most recent information about the account's balance. |
| 13 | * @property null|\Stripe\StripeObject $balance_refresh The state of the most recent attempt to refresh the account balance. |
| 14 | * @property string $category The type of the account. Account category is further divided in <code>subcategory</code>. |
| 15 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 16 | * @property null|string $display_name A human-readable name that has been assigned to this account, either by the account holder or by the institution. |
| 17 | * @property string $institution_name The name of the institution that holds this account. |
| 18 | * @property null|string $last4 The last 4 digits of the account number. If present, this will be 4 numeric characters. |
| 19 | * @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. |
| 20 | * @property null|string|\Stripe\FinancialConnections\AccountOwnership $ownership The most recent information about the account's owners. |
| 21 | * @property null|\Stripe\StripeObject $ownership_refresh The state of the most recent attempt to refresh the account owners. |
| 22 | * @property null|string[] $permissions The list of permissions granted by this account. |
| 23 | * @property string $status The status of the link to the account. |
| 24 | * @property string $subcategory <p>If <code>category</code> is <code>cash</code>, one of:</p><p>- <code>checking</code> - <code>savings</code> - <code>other</code></p><p>If <code>category</code> is <code>credit</code>, one of:</p><p>- <code>mortgage</code> - <code>line_of_credit</code> - <code>credit_card</code> - <code>other</code></p><p>If <code>category</code> is <code>investment</code> or <code>other</code>, this will be <code>other</code>.</p> |
| 25 | * @property null|string[] $subscriptions The list of data refresh subscriptions requested on this account. |
| 26 | * @property string[] $supported_payment_method_types The <a href="https://stripe.com/docs/api/payment_methods/object#payment_method_object-type">PaymentMethod type</a>(s) that can be created from this account. |
| 27 | * @property null|\Stripe\StripeObject $transaction_refresh The state of the most recent attempt to refresh the account transactions. |
| 28 | */ |
| 29 | class Account extends \ProfilePressVendor\Stripe\ApiResource |
| 30 | { |
| 31 | const OBJECT_NAME = 'financial_connections.account'; |
| 32 | const CATEGORY_CASH = 'cash'; |
| 33 | const CATEGORY_CREDIT = 'credit'; |
| 34 | const CATEGORY_INVESTMENT = 'investment'; |
| 35 | const CATEGORY_OTHER = 'other'; |
| 36 | const STATUS_ACTIVE = 'active'; |
| 37 | const STATUS_DISCONNECTED = 'disconnected'; |
| 38 | const STATUS_INACTIVE = 'inactive'; |
| 39 | const SUBCATEGORY_CHECKING = 'checking'; |
| 40 | const SUBCATEGORY_CREDIT_CARD = 'credit_card'; |
| 41 | const SUBCATEGORY_LINE_OF_CREDIT = 'line_of_credit'; |
| 42 | const SUBCATEGORY_MORTGAGE = 'mortgage'; |
| 43 | const SUBCATEGORY_OTHER = 'other'; |
| 44 | const SUBCATEGORY_SAVINGS = 'savings'; |
| 45 | /** |
| 46 | * Returns a list of Financial Connections <code>Account</code> objects. |
| 47 | * |
| 48 | * @param null|array $params |
| 49 | * @param null|array|string $opts |
| 50 | * |
| 51 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 52 | * |
| 53 | * @return \Stripe\Collection<\Stripe\FinancialConnections\Account> of ApiResources |
| 54 | */ |
| 55 | public static function all($params = null, $opts = null) |
| 56 | { |
| 57 | $url = static::classUrl(); |
| 58 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 59 | } |
| 60 | /** |
| 61 | * Retrieves the details of an Financial Connections <code>Account</code>. |
| 62 | * |
| 63 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 64 | * @param null|array|string $opts |
| 65 | * |
| 66 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 67 | * |
| 68 | * @return \Stripe\FinancialConnections\Account |
| 69 | */ |
| 70 | public static function retrieve($id, $opts = null) |
| 71 | { |
| 72 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 73 | $instance = new static($id, $opts); |
| 74 | $instance->refresh(); |
| 75 | return $instance; |
| 76 | } |
| 77 | /** |
| 78 | * @param null|array $params |
| 79 | * @param null|array|string $opts |
| 80 | * |
| 81 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 82 | * |
| 83 | * @return \Stripe\FinancialConnections\Account the disconnected account |
| 84 | */ |
| 85 | public function disconnect($params = null, $opts = null) |
| 86 | { |
| 87 | $url = $this->instanceUrl() . '/disconnect'; |
| 88 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 89 | $this->refreshFrom($response, $opts); |
| 90 | return $this; |
| 91 | } |
| 92 | /** |
| 93 | * @param string $id |
| 94 | * @param null|array $params |
| 95 | * @param null|array|string $opts |
| 96 | * |
| 97 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 98 | * |
| 99 | * @return \Stripe\Collection<\Stripe\FinancialConnections\AccountOwner> list of account owners |
| 100 | */ |
| 101 | public static function allOwners($id, $params = null, $opts = null) |
| 102 | { |
| 103 | $url = static::resourceUrl($id) . '/owners'; |
| 104 | list($response, $opts) = static::_staticRequest('get', $url, $params, $opts); |
| 105 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 106 | $obj->setLastResponse($response); |
| 107 | return $obj; |
| 108 | } |
| 109 | /** |
| 110 | * @param null|array $params |
| 111 | * @param null|array|string $opts |
| 112 | * |
| 113 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 114 | * |
| 115 | * @return \Stripe\FinancialConnections\Account the refreshed account |
| 116 | */ |
| 117 | public function refreshAccount($params = null, $opts = null) |
| 118 | { |
| 119 | $url = $this->instanceUrl() . '/refresh'; |
| 120 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 121 | $this->refreshFrom($response, $opts); |
| 122 | return $this; |
| 123 | } |
| 124 | /** |
| 125 | * @param null|array $params |
| 126 | * @param null|array|string $opts |
| 127 | * |
| 128 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 129 | * |
| 130 | * @return \Stripe\FinancialConnections\Account the subscribed account |
| 131 | */ |
| 132 | public function subscribe($params = null, $opts = null) |
| 133 | { |
| 134 | $url = $this->instanceUrl() . '/subscribe'; |
| 135 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 136 | $this->refreshFrom($response, $opts); |
| 137 | return $this; |
| 138 | } |
| 139 | /** |
| 140 | * @param null|array $params |
| 141 | * @param null|array|string $opts |
| 142 | * |
| 143 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 144 | * |
| 145 | * @return \Stripe\FinancialConnections\Account the unsubscribed account |
| 146 | */ |
| 147 | public function unsubscribe($params = null, $opts = null) |
| 148 | { |
| 149 | $url = $this->instanceUrl() . '/unsubscribe'; |
| 150 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 151 | $this->refreshFrom($response, $opts); |
| 152 | return $this; |
| 153 | } |
| 154 | } |
| 155 |