Class: Stripe::AccountLinkCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/account_link_create_params.rb

Defined Under Namespace

Classes: CollectionOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(account: nil, collect: nil, collection_options: nil, expand: nil, refresh_url: nil, return_url: nil, type: nil) ⇒ AccountLinkCreateParams

Returns a new instance of AccountLinkCreateParams.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/stripe/params/account_link_create_params.rb', line 34

def initialize(
  account: nil,
  collect: nil,
  collection_options: nil,
  expand: nil,
  refresh_url: nil,
  return_url: nil,
  type: nil
)
  @account = 
  @collect = collect
  @collection_options = collection_options
  @expand = expand
  @refresh_url = refresh_url
  @return_url = return_url
  @type = type
end

Instance Attribute Details

#account ⇒ Object

The identifier of the account to create an account link for.



18
19
20
 
# File 'lib/stripe/params/account_link_create_params.rb', line 18

def 
  @account
end

#collect ⇒ Object

The collect parameter is deprecated. Use ‘collection_options` instead.



20
21
22
 
# File 'lib/stripe/params/account_link_create_params.rb', line 20

def collect
  @collect
end

#collection_options ⇒ Object

Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.



22
23
24
 
# File 'lib/stripe/params/account_link_create_params.rb', line 22

def collection_options
  @collection_options
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



24
25
26
 
# File 'lib/stripe/params/account_link_create_params.rb', line 24

def expand
  @expand
end

#refresh_url ⇒ Object

The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link’s URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.



26
27
28
 
# File 'lib/stripe/params/account_link_create_params.rb', line 26

def refresh_url
  @refresh_url
end

#return_url ⇒ Object

The URL that the user will be redirected to upon leaving or completing the linked flow.



28
29
30
 
# File 'lib/stripe/params/account_link_create_params.rb', line 28

def return_url
  @return_url
end

#type ⇒ Object

The type of account link the user is requesting.

You can create Account Links of type ‘account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can’t create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components.



32
33
34
 
# File 'lib/stripe/params/account_link_create_params.rb', line 32

def type
  @type
end