ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
CashBalance.php
67 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe; |
| 6 | |
| 7 | /** |
| 8 | * A customer's <code>Cash balance</code> represents real funds. Customers can add |
| 9 | * funds to their cash balance by sending a bank transfer. These funds can be used |
| 10 | * for payment and can eventually be paid out to your bank account. |
| 11 | * |
| 12 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 13 | * @property null|\Stripe\StripeObject $available A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. |
| 14 | * @property string $customer The ID of the customer whose cash balance this object represents. |
| 15 | * @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. |
| 16 | * @property \Stripe\StripeObject $settings |
| 17 | */ |
| 18 | class CashBalance extends ApiResource |
| 19 | { |
| 20 | const OBJECT_NAME = 'cash_balance'; |
| 21 | |
| 22 | /** |
| 23 | * @return string the API URL for this balance transaction |
| 24 | */ |
| 25 | public function instanceUrl() |
| 26 | { |
| 27 | $customer = $this['customer']; |
| 28 | $customer = Util\Util::utf8($customer); |
| 29 | |
| 30 | $base = Customer::classUrl(); |
| 31 | $customerExtn = \urlencode($customer); |
| 32 | |
| 33 | return "{$base}/{$customerExtn}/cash_balance"; |
| 34 | } |
| 35 | |
| 36 | /** |
| 37 | * @param array|string $_id |
| 38 | * @param null|array|string $_opts |
| 39 | * |
| 40 | * @throws \Stripe\Exception\BadMethodCallException |
| 41 | */ |
| 42 | public static function retrieve($_id, $_opts = null) |
| 43 | { |
| 44 | $msg = 'Customer Cash Balance cannot be retrieved without a ' . |
| 45 | 'customer ID. Retrieve a Customer Cash Balance using ' . |
| 46 | "`Customer::retrieveCashBalance('customer_id')`."; |
| 47 | |
| 48 | throw new Exception\BadMethodCallException($msg); |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * @param string $_id |
| 53 | * @param null|array $_params |
| 54 | * @param null|array|string $_options |
| 55 | * |
| 56 | * @throws \Stripe\Exception\BadMethodCallException |
| 57 | */ |
| 58 | public static function update($_id, $_params = null, $_options = null) |
| 59 | { |
| 60 | $msg = 'Customer Cash Balance cannot be updated without a ' . |
| 61 | 'customer ID. Retrieve a Customer Cash Balance using ' . |
| 62 | "`Customer::updateCashBalance('customer_id')`."; |
| 63 | |
| 64 | throw new Exception\BadMethodCallException($msg); |
| 65 | } |
| 66 | } |
| 67 |