class Stripe::Account

Overview

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned. For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

Included Modules

Defined in:

stripe/models/account.cr

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [custom, express, none, standard]."
ERROR_MESSAGE_FOR_BUSINESS_TYPE = "invalid value for \"business_type\", must be one of [company, government_entity, individual, non_profit]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [account]."
MAX_LENGTH_FOR_COUNTRY = 5000
MAX_LENGTH_FOR_DEFAULT_CURRENCY = 5000
MAX_LENGTH_FOR_EMAIL = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR__TYPE = String.static_array("custom", "express", "none", "standard")
VALID_VALUES_FOR_BUSINESS_TYPE = String.static_array("company", "government_entity", "individual", "non_profit")
VALID_VALUES_FOR_OBJECT = String.static_array("account")

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, id : String | Nil = nil, object : String | Nil = nil, business_profile : Stripe::AccountBusinessProfile1 | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::AccountCapabilities | Nil = nil, charges_enabled : Bool | Nil = nil, company : Stripe::LegalEntityCompany | Nil = nil, controller : Stripe::AccountUnificationAccountController | Nil = nil, country : String | Nil = nil, created : Int64 | Nil = nil, default_currency : String | Nil = nil, details_submitted : Bool | Nil = nil, email : String | Nil = nil, external_accounts : Stripe::ExternalAccountList | Nil = nil, future_requirements : Stripe::AccountFutureRequirements | Nil = nil, individual : Stripe::Person | Nil = nil, metadata : Hash(String, String) | Nil = nil, payouts_enabled : Bool | Nil = nil, requirements : Stripe::AccountRequirements | Nil = nil, settings : Stripe::AccountSettings1 | Nil = nil, tos_acceptance : Stripe::AccountTosAcceptance | Nil = nil, _type : String | Nil = nil) #

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


[View source]

Instance Method Detail

def ==(other : self) #

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


def _type : String | Nil #

[View source]
def _type=(new_value : String | Nil) #

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


[View source]
def business_profile : Stripe::AccountBusinessProfile1 | Nil #

[View source]
def business_profile=(new_value : Stripe::AccountBusinessProfile1 | Nil) #

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


[View source]
def business_profile_present=(business_profile_present : Bool) #

[View source]
def business_profile_present? : Bool #

[View source]
def business_type : String | Nil #

[View source]
def business_type=(new_value : String | Nil) #

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


[View source]
def business_type_present=(business_type_present : Bool) #

[View source]
def business_type_present? : Bool #

[View source]
def capabilities : Stripe::AccountCapabilities | Nil #

[View source]
def capabilities=(new_value : Stripe::AccountCapabilities | Nil) #

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


[View source]
def charges_enabled : Bool | Nil #

[View source]
def charges_enabled=(new_value : Bool | Nil) #

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


[View source]
def company : Stripe::LegalEntityCompany | Nil #

[View source]
def company=(new_value : Stripe::LegalEntityCompany | Nil) #

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


[View source]

[View source]
def controller=(new_value : Stripe::AccountUnificationAccountController | Nil) #

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


[View source]
def country : String | Nil #

[View source]
def country=(new_value : String | Nil) #

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


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def default_currency : String | Nil #

[View source]
def default_currency=(new_value : String | Nil) #

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


[View source]
def details_submitted : Bool | Nil #

[View source]
def details_submitted=(new_value : Bool | Nil) #

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


[View source]
def email : String | Nil #

[View source]
def email=(new_value : String | Nil) #

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


[View source]
def email_present=(email_present : Bool) #

[View source]
def email_present? : Bool #

[View source]
def external_accounts : Stripe::ExternalAccountList | Nil #

[View source]
def external_accounts=(new_value : Stripe::ExternalAccountList | Nil) #

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


[View source]
def future_requirements : Stripe::AccountFutureRequirements | Nil #

[View source]
def future_requirements=(new_value : Stripe::AccountFutureRequirements | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def individual : Stripe::Person | Nil #

[View source]
def individual=(new_value : Stripe::Person | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def payouts_enabled : Bool | Nil #

[View source]
def payouts_enabled=(new_value : Bool | Nil) #

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


[View source]
def requirements : Stripe::AccountRequirements | Nil #

[View source]
def requirements=(new_value : Stripe::AccountRequirements | Nil) #

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


[View source]
def settings : Stripe::AccountSettings1 | Nil #

[View source]
def settings=(new_value : Stripe::AccountSettings1 | Nil) #

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


[View source]
def settings_present=(settings_present : Bool) #

[View source]
def settings_present? : Bool #

[View source]
def tos_acceptance : Stripe::AccountTosAcceptance | Nil #

[View source]
def tos_acceptance=(new_value : Stripe::AccountTosAcceptance | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]