class

Stripe::AccountLinksApi

Inherits Reference < Object

Constants

POST_ACCOUNT_LINKS_MAX_LENGTH_FOR_ACCOUNT = 5000
POST_ACCOUNT_LINKS_VALID_VALUES_FOR__TYPE = String.static_array("account_onboarding", "account_update")
POST_ACCOUNT_LINKS_VALID_VALUES_FOR_COLLECT = String.static_array("currently_due", "eventually_due")

Constructors

new(api_client : Stripe::ApiClient = ApiClient.default)
Source

Instance methods

api_client
Source
api_client=(api_client : ApiClient)
Source
build_api_request_for_post_account_links(*, account : String | Nil = nil, _type : String | Nil = nil, collect : String | Nil = nil, collection_options : Stripe::CollectionOptionsParams | Nil = nil, expand : Array(String) | Nil = nil, refresh_url : String | Nil = nil, return_url : String | Nil = nil) : Crest::Request

@return Crest::Request

Source
client_side_validation?(*args, **options)
Source
client_side_validation?(*args, **options, &)
Source
debugging?(*args, **options)
Source
debugging?(*args, **options, &)
Source
post_account_links(*, account : String | Nil = nil, _type : String | Nil = nil, collect : String | Nil = nil, collection_options : Stripe::CollectionOptionsParams | Nil = nil, expand : Array(String) | Nil = nil, refresh_url : String | Nil = nil, return_url : String | Nil = nil) : Stripe::AccountLink

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

@required @param account [String?] The identifier of the account to create an account link for. @required @param _type [String?] The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. @optional @param collect [String?] The collect parameter is deprecated. Use `collection_options` instead. @optional @param collection_options [Stripe::CollectionOptionsParams?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refresh_url [String?] 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. @optional @param return_url [String?] The URL that the user will be redirected to upon leaving or completing the linked flow. @return [Stripe::AccountLink]
Source
post_account_links(*, account : String | Nil = nil, _type : String | Nil = nil, collect : String | Nil = nil, collection_options : Stripe::CollectionOptionsParams | Nil = nil, expand : Array(String) | Nil = nil, refresh_url : String | Nil = nil, return_url : String | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.</p> @required @param account [String?] The identifier of the account to create an account link for. @required @param _type [String?] The type of account link the user is requesting. Possible values are account_onboarding or account_update. @optional @param collect [String?] The collect parameter is deprecated. Use collection_options instead. @optional @param collection_options [Stripe::CollectionOptionsParams?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refresh_url [String?] 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. @optional @param return_url [String?] The URL that the user will be redirected to upon leaving or completing the linked flow. @return nil

Source
post_account_links_with_http_info(*, account : String | Nil = nil, _type : String | Nil = nil, collect : String | Nil = nil, collection_options : Stripe::CollectionOptionsParams | Nil = nil, expand : Array(String) | Nil = nil, refresh_url : String | Nil = nil, return_url : String | Nil = nil) : Tuple(Stripe::AccountLink, Int32, Hash(String, Array(String) | String))

<p>Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.</p> @required @param account [String?] The identifier of the account to create an account link for. @required @param _type [String?] The type of account link the user is requesting. Possible values are account_onboarding or account_update. @optional @param collect [String?] The collect parameter is deprecated. Use collection_options instead. @optional @param collection_options [Stripe::CollectionOptionsParams?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param refresh_url [String?] 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. @optional @param return_url [String?] The URL that the user will be redirected to upon leaving or completing the linked flow. @return [Tuple(Stripe::AccountLink, Integer, Hash)] Stripe::AccountLink, response status code and response headers

Source