class

Stripe::BankAccount

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

These bank accounts are payment methods on Customer objects. On the other hand External Accounts are transfer destinations on Account objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: Bank debits and transfers

Constants

ERROR_MESSAGE_FOR_AVAILABLE_PAYOUT_METHODS = "invalid value for \"available_payout_methods\", must be one of [instant, standard]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [bank_account]."
MAX_LENGTH_FOR_ACCOUNT_HOLDER_NAME = 5000
MAX_LENGTH_FOR_ACCOUNT_HOLDER_TYPE = 5000
MAX_LENGTH_FOR_ACCOUNT_TYPE = 5000
MAX_LENGTH_FOR_BANK_NAME = 5000
MAX_LENGTH_FOR_COUNTRY = 5000
MAX_LENGTH_FOR_FINGERPRINT = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_LAST4 = 5000
MAX_LENGTH_FOR_ROUTING_NUMBER = 5000
MAX_LENGTH_FOR_STATUS = 5000
VALID_VALUES_FOR_AVAILABLE_PAYOUT_METHODS = String.static_array("instant", "standard")
VALID_VALUES_FOR_OBJECT = String.static_array("bank_account")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, account_type : String | Nil = nil, bank_name : String | Nil = nil, country : String | Nil = nil, currency : String | Nil = nil, fingerprint : String | Nil = nil, id : String | Nil = nil, last4 : String | Nil = nil, object : String | Nil = nil, routing_number : String | Nil = nil, status : String | Nil = nil, account : Stripe::BankAccountAccount | Nil = nil, available_payout_methods : Array(String) | Nil = nil, customer : Stripe::BankAccountCustomer | Nil = nil, default_for_currency : Bool | Nil = nil, future_requirements : Stripe::BankAccountFutureRequirements | Nil = nil, metadata : Hash(String, String) | Nil = nil, requirements : Stripe::BankAccountRequirements | 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
Source
account=(new_value : Stripe::BankAccountAccount | Nil)

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

Source
account_holder_name

The name of the person or business that owns the bank account.

Source
account_holder_name=(new_value : String | Nil)

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

Source
account_holder_type

The type of entity that holds the account. This can be either individual or company.

Source
account_holder_type=(new_value : String | Nil)

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

Source
account_present=(account_present : Bool)
Source
account_present?
Source
account_type

The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

Source
account_type=(new_value : String | Nil)

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

Source
available_payout_methods

A set of available payout methods for this bank account. Only values from this set should be passed as the method when creating a payout.

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

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

Source
available_payout_methods_present=(available_payout_methods_present : Bool)
Source
available_payout_methods_present?
Source
bank_name

Name of the bank associated with the routing number (e.g., WELLS FARGO).

Source
bank_name=(new_value : String | Nil)

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

Source
country

Two-letter ISO code representing the country the bank account is located in.

Source
country=(new_value : String | Nil)

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

Source
currency

Three-letter ISO code for the currency paid out to the bank account.

Source
currency=(new_value : String | Nil)

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

Source
customer
Source
customer=(new_value : Stripe::BankAccountCustomer | Nil)

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

Source
customer_present=(customer_present : Bool)
Source
customer_present?
Source
default_for_currency

Whether this bank account is the default external account for its currency.

Source
default_for_currency=(new_value : Bool | Nil)

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

Source
default_for_currency_present=(default_for_currency_present : Bool)
Source
default_for_currency_present?
Source
fingerprint

Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

Source
fingerprint=(new_value : String | Nil)

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

Source
future_requirements
Source
future_requirements=(new_value : Stripe::BankAccountFutureRequirements | Nil)

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

Source
future_requirements_present=(future_requirements_present : Bool)
Source
future_requirements_present?
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
last4

The last four digits of the bank account number.

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
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

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

Source
metadata_present=(metadata_present : Bool)
Source
metadata_present?
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
requirements
Source
requirements=(new_value : Stripe::BankAccountRequirements | Nil)

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

Source
requirements_present=(requirements_present : Bool)
Source
requirements_present?
Source
routing_number

The routing transit number for the bank account.

Source
routing_number=(new_value : String | Nil)

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

Source
status

For bank accounts, possible values are new, validated, verified, verification_failed, or errored. A bank account that hasn't had any activity or validation performed is new. If Stripe can determine that the bank account exists, its status will be validated. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be verified. If the verification failed for any reason, such as microdeposit failure, the status will be verification_failed. If a payout sent to this bank account fails, we'll set the status to errored and will not continue to send scheduled payouts until the bank details are updated. For external accounts, possible values are new, errored and verification_failed. If a payout fails, the status is set to errored and scheduled payouts are stopped until account details are updated. In the US and India, if we can't verify the owner of the bank account, we'll set the status to verification_failed. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.

Source
status=(new_value : String | Nil)

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