ApiOperations
6 years ago
Checkout
6 years ago
Error
6 years ago
HttpClient
6 years ago
Issuing
6 years ago
Radar
6 years ago
Reporting
6 years ago
Sigma
6 years ago
Terminal
6 years ago
Util
6 years ago
Account.php
6 years ago
AccountLink.php
6 years ago
AlipayAccount.php
6 years ago
ApiRequestor.php
6 years ago
ApiResource.php
6 years ago
ApiResponse.php
6 years ago
ApplePayDomain.php
6 years ago
ApplicationFee.php
6 years ago
ApplicationFeeRefund.php
6 years ago
Balance.php
6 years ago
BalanceTransaction.php
6 years ago
BankAccount.php
6 years ago
BitcoinReceiver.php
6 years ago
BitcoinTransaction.php
6 years ago
Capability.php
6 years ago
Card.php
6 years ago
Charge.php
6 years ago
Collection.php
6 years ago
CountrySpec.php
6 years ago
Coupon.php
6 years ago
CreditNote.php
6 years ago
Customer.php
6 years ago
CustomerBalanceTransaction.php
6 years ago
Discount.php
6 years ago
Dispute.php
6 years ago
EphemeralKey.php
6 years ago
Event.php
6 years ago
ExchangeRate.php
6 years ago
File.php
6 years ago
FileLink.php
6 years ago
FileUpload.php
6 years ago
Invoice.php
6 years ago
InvoiceItem.php
6 years ago
InvoiceLineItem.php
6 years ago
IssuerFraudRecord.php
6 years ago
LoginLink.php
6 years ago
OAuth.php
6 years ago
Order.php
6 years ago
OrderItem.php
6 years ago
OrderReturn.php
6 years ago
PaymentIntent.php
6 years ago
PaymentMethod.php
6 years ago
Payout.php
6 years ago
Person.php
6 years ago
Plan.php
6 years ago
Product.php
6 years ago
Recipient.php
6 years ago
RecipientTransfer.php
6 years ago
Refund.php
6 years ago
RequestTelemetry.php
6 years ago
Review.php
6 years ago
SKU.php
6 years ago
SetupIntent.php
6 years ago
SingletonApiResource.php
6 years ago
Source.php
6 years ago
SourceTransaction.php
6 years ago
Stripe.php
6 years ago
StripeObject.php
6 years ago
Subscription.php
6 years ago
SubscriptionItem.php
6 years ago
SubscriptionSchedule.php
6 years ago
TaxId.php
6 years ago
TaxRate.php
6 years ago
ThreeDSecure.php
6 years ago
Token.php
6 years ago
Topup.php
6 years ago
Transfer.php
6 years ago
TransferReversal.php
6 years ago
UsageRecord.php
6 years ago
UsageRecordSummary.php
6 years ago
Webhook.php
6 years ago
WebhookEndpoint.php
6 years ago
WebhookSignature.php
6 years ago
BankAccount.php
109 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Stripe; |
| 4 | |
| 5 | /** |
| 6 | * Class BankAccount |
| 7 | * |
| 8 | * @property string $id |
| 9 | * @property string $object |
| 10 | * @property string $account |
| 11 | * @property string $account_holder_name |
| 12 | * @property string $account_holder_type |
| 13 | * @property string $bank_name |
| 14 | * @property string $country |
| 15 | * @property string $currency |
| 16 | * @property string $customer |
| 17 | * @property bool $default_for_currency |
| 18 | * @property string $fingerprint |
| 19 | * @property string $last4 |
| 20 | * @property StripeObject $metadata |
| 21 | * @property string $routing_number |
| 22 | * @property string $status |
| 23 | * |
| 24 | * @package Stripe |
| 25 | */ |
| 26 | class BankAccount extends ApiResource |
| 27 | { |
| 28 | const OBJECT_NAME = "bank_account"; |
| 29 | |
| 30 | use ApiOperations\Delete; |
| 31 | use ApiOperations\Update; |
| 32 | |
| 33 | /** |
| 34 | * Possible string representations of the bank verification status. |
| 35 | * @link https://stripe.com/docs/api/external_account_bank_accounts/object#account_bank_account_object-status |
| 36 | */ |
| 37 | const STATUS_NEW = 'new'; |
| 38 | const STATUS_VALIDATED = 'validated'; |
| 39 | const STATUS_VERIFIED = 'verified'; |
| 40 | const STATUS_VERIFICATION_FAILED = 'verification_failed'; |
| 41 | const STATUS_ERRORED = 'errored'; |
| 42 | |
| 43 | /** |
| 44 | * @return string The instance URL for this resource. It needs to be special |
| 45 | * cased because it doesn't fit into the standard resource pattern. |
| 46 | */ |
| 47 | public function instanceUrl() |
| 48 | { |
| 49 | if ($this['customer']) { |
| 50 | $base = Customer::classUrl(); |
| 51 | $parent = $this['customer']; |
| 52 | $path = 'sources'; |
| 53 | } elseif ($this['account']) { |
| 54 | $base = Account::classUrl(); |
| 55 | $parent = $this['account']; |
| 56 | $path = 'external_accounts'; |
| 57 | } else { |
| 58 | $msg = "Bank accounts cannot be accessed without a customer ID or account ID."; |
| 59 | throw new Error\InvalidRequest($msg, null); |
| 60 | } |
| 61 | $parentExtn = urlencode(Util\Util::utf8($parent)); |
| 62 | $extn = urlencode(Util\Util::utf8($this['id'])); |
| 63 | return "$base/$parentExtn/$path/$extn"; |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * @param array|string $_id |
| 68 | * @param array|string|null $_opts |
| 69 | * |
| 70 | * @throws \Stripe\Error\InvalidRequest |
| 71 | */ |
| 72 | public static function retrieve($_id, $_opts = null) |
| 73 | { |
| 74 | $msg = "Bank accounts cannot be accessed without a customer ID or account ID. " . |
| 75 | "Retrieve a bank account using \$customer->sources->retrieve('bank_account_id') or " . |
| 76 | "\$account->external_accounts->retrieve('bank_account_id') instead."; |
| 77 | throw new Error\InvalidRequest($msg, null); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * @param string $_id |
| 82 | * @param array|null $_params |
| 83 | * @param array|string|null $_options |
| 84 | * |
| 85 | * @throws \Stripe\Error\InvalidRequest |
| 86 | */ |
| 87 | public static function update($_id, $_params = null, $_options = null) |
| 88 | { |
| 89 | $msg = "Bank accounts cannot be accessed without a customer ID or account ID. " . |
| 90 | "Call save() on \$customer->sources->retrieve('bank_account_id') or " . |
| 91 | "\$account->external_accounts->retrieve('bank_account_id') instead."; |
| 92 | throw new Error\InvalidRequest($msg, null); |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * @param array|null $params |
| 97 | * @param array|string|null $options |
| 98 | * |
| 99 | * @return BankAccount The verified bank account. |
| 100 | */ |
| 101 | public function verify($params = null, $options = null) |
| 102 | { |
| 103 | $url = $this->instanceUrl() . '/verify'; |
| 104 | list($response, $opts) = $this->_request('post', $url, $params, $options); |
| 105 | $this->refreshFrom($response, $opts); |
| 106 | return $this; |
| 107 | } |
| 108 | } |
| 109 |