Class: Stripe::CashBalance

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/cash_balance.rb

Overview

A customer’s ‘Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.

Defined Under Namespace

Classes: Settings

Constant Summary collapse

OBJECT_NAME = 
"cash_balance"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#available ⇒ Object (readonly)

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. Amounts are represented in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal).



19
20
21
 
# File 'lib/stripe/resources/cash_balance.rb', line 19

def available
  @available
end

#customer ⇒ Object (readonly)

The ID of the customer whose cash balance this object represents.



21
22
23
 
# File 'lib/stripe/resources/cash_balance.rb', line 21

def customer
  @customer
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



23
24
25
 
# File 'lib/stripe/resources/cash_balance.rb', line 23

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



25
26
27
 
# File 'lib/stripe/resources/cash_balance.rb', line 25

def object
  @object
end

#settings ⇒ Object (readonly)

Attribute for field settings



27
28
29
 
# File 'lib/stripe/resources/cash_balance.rb', line 27

def settings
  @settings
end

Class Method Details

.object_name ⇒ Object 



8
9
10
 
# File 'lib/stripe/resources/cash_balance.rb', line 8

def self.object_name
  "cash_balance"
end

.retrieve(_id, _opts = {}) ⇒ Object

Raises:

  • (NotImplementedError) 


37
38
39
40
41
 
# File 'lib/stripe/resources/cash_balance.rb', line 37

def self.retrieve(_id, _opts = {})
  raise NotImplementedError,
        "Customer Cash Balance cannot be retrieved without a customer ID. " \
        "Retrieve a Customer Cash Balance using `Customer.retrieve_cash_balance('cus_123')`"
end

Instance Method Details

#resource_url ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/stripe/resources/cash_balance.rb', line 29

def resource_url
  if !respond_to?(:customer) || customer.nil?
    raise NotImplementedError,
          "Customer Cash Balance cannot be accessed without a customer ID."
  end
  "#{Customer.resource_url}/#{CGI.escape(customer)}/cash_balance"
end