class

Stripe::FinancialConnectionsSession

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [financial_connections.session]."
ERROR_MESSAGE_FOR_PERMISSIONS = "invalid value for \"permissions\", must be one of [balances, ownership, payment_method, transactions]."
ERROR_MESSAGE_FOR_PREFETCH = "invalid value for \"prefetch\", must be one of [balances, ownership, transactions]."
MAX_LENGTH_FOR_CLIENT_SECRET = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_RETURN_URL = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("financial_connections.session")
VALID_VALUES_FOR_PERMISSIONS = String.static_array("balances", "ownership", "payment_method", "transactions")
VALID_VALUES_FOR_PREFETCH = String.static_array("balances", "ownership", "transactions")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_holder : Stripe::FinancialConnectionsSessionAccountHolder | Nil = nil, accounts : Stripe::BankConnectionsResourceLinkedAccountList | Nil = nil, client_secret : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, permissions : Array(String) | Nil = nil, prefetch : Array(String) | Nil = nil, filters : Stripe::BankConnectionsResourceLinkAccountSessionFilters | Nil = nil, return_url : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

account_holder
Source
account_holder=(new_value : Stripe::FinancialConnectionsSessionAccountHolder | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_holder Object to be assigned

Source
accounts
Source
accounts=(new_value : Stripe::BankConnectionsResourceLinkedAccountList | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] accounts Object to be assigned

Source
client_secret

A value that will be passed to the client to launch the authentication flow.

Source
client_secret=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_secret Object to be assigned

Source
filters
Source
filters=(new_value : Stripe::BankConnectionsResourceLinkAccountSessionFilters | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] filters Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
permissions

Permissions requested for accounts collected during this session.

Source
permissions=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] permissions Object to be assigned

Source
prefetch

Data features requested to be retrieved upon account creation.

Source
prefetch=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] prefetch Object to be assigned

Source
return_url

For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

Source
return_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] return_url Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source