class

Stripe::FinancialConnectionsAccount

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

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

Constants

ERROR_MESSAGE_FOR_CATEGORY = "invalid value for \"category\", must be one of [cash, credit, investment, other]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [financial_connections.account]."
ERROR_MESSAGE_FOR_PERMISSIONS = "invalid value for \"permissions\", must be one of [balances, ownership, payment_method, transactions]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, disconnected, inactive]."
ERROR_MESSAGE_FOR_SUBCATEGORY = "invalid value for \"subcategory\", must be one of [checking, credit_card, line_of_credit, mortgage, other, savings]."
ERROR_MESSAGE_FOR_SUBSCRIPTIONS = "invalid value for \"subscriptions\", must be one of [transactions]."
ERROR_MESSAGE_FOR_SUPPORTED_PAYMENT_METHOD_TYPES = "invalid value for \"supported_payment_method_types\", must be one of [link, us_bank_account]."
MAX_LENGTH_FOR_DISPLAY_NAME = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_INSTITUTION_NAME = 5000
MAX_LENGTH_FOR_LAST4 = 5000
VALID_VALUES_FOR_CATEGORY = String.static_array("cash", "credit", "investment", "other")
VALID_VALUES_FOR_OBJECT = String.static_array("financial_connections.account")
VALID_VALUES_FOR_PERMISSIONS = String.static_array("balances", "ownership", "payment_method", "transactions")
VALID_VALUES_FOR_STATUS = String.static_array("active", "disconnected", "inactive")
VALID_VALUES_FOR_SUBCATEGORY = String.static_array("checking", "credit_card", "line_of_credit", "mortgage", "other", "savings")
VALID_VALUES_FOR_SUBSCRIPTIONS = String.static_array("transactions")
VALID_VALUES_FOR_SUPPORTED_PAYMENT_METHOD_TYPES = String.static_array("link", "us_bank_account")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_holder : Stripe::FinancialConnectionsAccountAccountHolder | Nil = nil, balance : Stripe::FinancialConnectionsAccountBalance | Nil = nil, balance_refresh : Stripe::FinancialConnectionsAccountBalanceRefresh | Nil = nil, category : String | Nil = nil, created : Int64 | Nil = nil, display_name : String | Nil = nil, id : String | Nil = nil, institution_name : String | Nil = nil, last4 : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, ownership : Stripe::FinancialConnectionsAccountOwnership1 | Nil = nil, ownership_refresh : Stripe::FinancialConnectionsAccountOwnershipRefresh | Nil = nil, permissions : Array(String) | Nil = nil, status : String | Nil = nil, subcategory : String | Nil = nil, subscriptions : Array(String) | Nil = nil, supported_payment_method_types : Array(String) | Nil = nil, transaction_refresh : Stripe::FinancialConnectionsAccountTransactionRefresh | 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::FinancialConnectionsAccountAccountHolder | Nil)

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

Source
balance
Source
balance=(new_value : Stripe::FinancialConnectionsAccountBalance | Nil)

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

Source
balance_refresh
Source
balance_refresh=(new_value : Stripe::FinancialConnectionsAccountBalanceRefresh | Nil)

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

Source
category

The type of the account. Account category is further divided in subcategory.

Source
category=(new_value : String | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
display_name

A human-readable name that has been assigned to this account, either by the account holder or by the institution.

Source
display_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] display_name 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
institution_name

The name of the institution that holds this account.

Source
institution_name=(new_value : String | Nil)

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

Source
last4

The last 4 digits of the account number. If present, this will be 4 numeric characters.

Source
last4=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] last4 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
ownership
Source
ownership=(new_value : Stripe::FinancialConnectionsAccountOwnership1 | Nil)

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

Source
ownership_refresh
Source
ownership_refresh=(new_value : Stripe::FinancialConnectionsAccountOwnershipRefresh | Nil)

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

Source
permissions

The list of permissions granted by this account.

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

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

Source
status

The status of the link to the account.

Source
status=(new_value : String | Nil)

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

Source
subcategory

If category is cash, one of: - checking - savings - other If category is credit, one of: - mortgage - line_of_credit - credit_card - other If category is investment or other, this will be other.

Source
subcategory=(new_value : String | Nil)

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

Source
subscriptions

The list of data refresh subscriptions requested on this account.

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

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

Source
supported_payment_method_types

The PaymentMethod type(s) that can be created from this account.

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

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

Source
transaction_refresh
Source
transaction_refresh=(new_value : Stripe::FinancialConnectionsAccountTransactionRefresh | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transaction_refresh 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