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.



1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'lib/stripe/services/account_service.rb', line 1931

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.



1894
1895
1896
 
# File 'lib/stripe/services/account_service.rb', line 1894

def 
  @account_token
end

#business_profile ⇒ Object

Business information about the account.



1896
1897
1898
 
# File 'lib/stripe/services/account_service.rb', line 1896

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.



1898
1899
1900
 
# File 'lib/stripe/services/account_service.rb', line 1898

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.



1907
1908
1909
 
# File 'lib/stripe/services/account_service.rb', line 1907

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.



1909
1910
1911
 
# File 'lib/stripe/services/account_service.rb', line 1909

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).



1911
1912
1913
 
# File 'lib/stripe/services/account_service.rb', line 1911

def default_currency
  @default_currency
end

#documents ⇒ Object

Documents that may be submitted to satisfy various informational requests.



1913
1914
1915
 
# File 'lib/stripe/services/account_service.rb', line 1913

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.



1915
1916
1917
 
# File 'lib/stripe/services/account_service.rb', line 1915

def email
  @email
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1917
1918
1919
 
# File 'lib/stripe/services/account_service.rb', line 1917

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.



1919
1920
1921
 
# File 'lib/stripe/services/account_service.rb', line 1919

def 
  @external_account
end

#groups ⇒ Object

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



1921
1922
1923
 
# File 'lib/stripe/services/account_service.rb', line 1921

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.



1923
1924
1925
 
# File 'lib/stripe/services/account_service.rb', line 1923

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`.



1925
1926
1927
 
# File 'lib/stripe/services/account_service.rb', line 1925

def metadata
  @metadata
end

#settings ⇒ Object

Options for customizing how the account functions within Stripe.



1927
1928
1929
 
# File 'lib/stripe/services/account_service.rb', line 1927

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.



1929
1930
1931
 
# File 'lib/stripe/services/account_service.rb', line 1929

def tos_acceptance
  @tos_acceptance
end