Class: Stripe::AccountService::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/account_service.rb

Defined Under Namespace

Classes: BankAccount, BusinessProfile, Capabilities, Card, CardToken, Company, Documents, Groups, Individual, Settings, TosAcceptance

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(account_token: nil, business_profile: nil, business_type: nil, capabilities: nil, company: nil, default_currency: nil, documents: nil, email: nil, expand: nil, external_account: nil, groups: nil, individual: nil, metadata: nil, settings: nil, tos_acceptance: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
 
# File 'lib/stripe/services/account_service.rb', line 2005

def initialize(
  account_token: nil,
  business_profile: nil,
  business_type: nil,
  capabilities: nil,
  company: nil,
  default_currency: nil,
  documents: nil,
  email: nil,
  expand: nil,
  external_account: nil,
  groups: nil,
  individual: nil,
  metadata: nil,
  settings: nil,
  tos_acceptance: nil
)
  @account_token = 
  @business_profile = business_profile
  @business_type = business_type
  @capabilities = capabilities
  @company = company
  @default_currency = default_currency
  @documents = documents
  @email = email
  @expand = expand
  @external_account = 
  @groups = groups
  @individual = individual
  @metadata = metadata
  @settings = settings
  @tos_acceptance = tos_acceptance
end

Instance Attribute Details

#account_token ⇒ Object

An [account token](stripe.com/docs/api#create_account_token), used to securely provide details to the account.



1968
1969
1970
 
# File 'lib/stripe/services/account_service.rb', line 1968

def 
  @account_token
end

#business_profile ⇒ Object

Business information about the account.



1970
1971
1972
 
# File 'lib/stripe/services/account_service.rb', line 1970

def business_profile
  @business_profile
end

#business_type ⇒ Object

The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is ‘application`, which includes Custom accounts.



1972
1973
1974
 
# File 'lib/stripe/services/account_service.rb', line 1972

def business_type
  @business_type
end

#capabilities ⇒ Object

Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive.

Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type) is ‘none`, which includes Custom accounts.



1981
1982
1983
 
# File 'lib/stripe/services/account_service.rb', line 1981

def capabilities
  @capabilities
end

#company ⇒ Object

Information about the company or business. This field is available for any ‘business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.



1983
1984
1985
 
# File 'lib/stripe/services/account_service.rb', line 1983

def company
  @company
end

#default_currency ⇒ Object

Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account’s country](docs.stripe.com/payouts).



1985
1986
1987
 
# File 'lib/stripe/services/account_service.rb', line 1985

def default_currency
  @default_currency
end

#documents ⇒ Object

Documents that may be submitted to satisfy various informational requests.



1987
1988
1989
 
# File 'lib/stripe/services/account_service.rb', line 1987

def documents
  @documents
end

#email ⇒ Object

The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is ‘application`, which includes Custom accounts, Stripe doesn’t email the account without your consent.



1989
1990
1991
 
# File 'lib/stripe/services/account_service.rb', line 1989

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1991
1992
1993
 
# File 'lib/stripe/services/account_service.rb', line 1991

def expand
  @expand
end

#external_account ⇒ Object

A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the ‘external_account` parameter for [bank account](/api#account_create_bank_account) creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.



1993
1994
1995
 
# File 'lib/stripe/services/account_service.rb', line 1993

def 
  @external_account
end

#groups ⇒ Object

A hash of account group type to tokens. These are account groups this account should be added to.



1995
1996
1997
 
# File 'lib/stripe/services/account_service.rb', line 1995

def groups
  @groups
end

#individual ⇒ Object

Information about the person represented by the account. This field is null unless ‘business_type` is set to `individual`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.



1997
1998
1999
 
# File 'lib/stripe/services/account_service.rb', line 1997

def individual
  @individual
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`.



1999
2000
2001
 
# File 'lib/stripe/services/account_service.rb', line 1999

def metadata
  @metadata
end

#settings ⇒ Object

Options for customizing how the account functions within Stripe.



2001
2002
2003
 
# File 'lib/stripe/services/account_service.rb', line 2001

def settings
  @settings
end

#tos_acceptance ⇒ Object

Details on the account’s acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). This property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is ‘application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.



2003
2004
2005
 
# File 'lib/stripe/services/account_service.rb', line 2003

def tos_acceptance
  @tos_acceptance
end