Class: Stripe::Treasury::FinancialAccount::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/treasury/financial_account.rb

Defined Under Namespace

Classes: Features, PlatformRestrictions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(display_name: nil, expand: nil, features: nil, metadata: nil, nickname: nil, platform_restrictions: nil, supported_currencies: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 295

def initialize(
  display_name: nil,
  expand: nil,
  features: nil,
  metadata: nil,
  nickname: nil,
  platform_restrictions: nil,
  supported_currencies: nil
)
  @display_name = display_name
  @expand = expand
  @features = features
  @metadata = metadata
  @nickname = nickname
  @platform_restrictions = platform_restrictions
  @supported_currencies = supported_currencies
end

Instance Attribute Details

#display_name ⇒ Object

The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the ‘nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.



281
282
283
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 281

def display_name
  @display_name
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



283
284
285
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 283

def expand
  @expand
end

#features ⇒ Object

Encodes whether a FinancialAccount has access to a particular feature. Stripe or the platform can control features via the requested field.



285
286
287
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 285

def features
  @features
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



287
288
289
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 287

def metadata
  @metadata
end

#nickname ⇒ Object

The nickname for the FinancialAccount.



289
290
291
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 289

def nickname
  @nickname
end

#platform_restrictions ⇒ Object

The set of functionalities that the platform can restrict on the FinancialAccount.



291
292
293
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 291

def platform_restrictions
  @platform_restrictions
end

#supported_currencies ⇒ Object

The currencies the FinancialAccount can hold a balance in.



293
294
295
 
# File 'lib/stripe/resources/treasury/financial_account.rb', line 293

def supported_currencies
  @supported_currencies
end