Class: Stripe::FundingInstructions

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

Overview

Each customer has a [‘balance`](stripe.com/docs/api/customers/object#customer_object-balance) that is automatically applied to future invoices and payments using the `customer_balance` payment method. Customers can fund this balance by initiating a bank transfer to any account in the `financial_addresses` field. Related guide: [Customer balance funding instructions](stripe.com/docs/payments/customer-balance/funding-instructions)

Defined Under Namespace

Classes: BankTransfer

Constant Summary collapse

OBJECT_NAME = 
"funding_instructions"

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, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, 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

#bank_transfer ⇒ Object (readonly)

Attribute for field bank_transfer



499
500
501
 
# File 'lib/stripe/resources/funding_instructions.rb', line 499

def bank_transfer
  @bank_transfer
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



501
502
503
 
# File 'lib/stripe/resources/funding_instructions.rb', line 501

def currency
  @currency
end

#funding_type ⇒ Object (readonly)

The ‘funding_type` of the returned instructions



503
504
505
 
# File 'lib/stripe/resources/funding_instructions.rb', line 503

def funding_type
  @funding_type
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.



505
506
507
 
# File 'lib/stripe/resources/funding_instructions.rb', line 505

def livemode
  @livemode
end

#object ⇒ Object (readonly)

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



507
508
509
 
# File 'lib/stripe/resources/funding_instructions.rb', line 507

def object
  @object
end

Class Method Details

.field_remappings ⇒ Object 



521
522
523
 
# File 'lib/stripe/resources/funding_instructions.rb', line 521

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



517
518
519
 
# File 'lib/stripe/resources/funding_instructions.rb', line 517

def self.inner_class_types
  @inner_class_types = { bank_transfer: BankTransfer }
end

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/funding_instructions.rb', line 12

def self.object_name
  "funding_instructions"
end

Instance Method Details

#resource_url ⇒ Object 



509
510
511
512
513
514
515
 
# File 'lib/stripe/resources/funding_instructions.rb', line 509

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