class Stripe::AccountsApi
- Stripe::AccountsApi
- Reference
- Object
Defined in:
stripe/api/accounts_api.crConstant Summary
-
DELETE_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT =
5000
-
DELETE_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
DELETE_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_ACCOUNT =
5000
-
DELETE_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_PERSON =
5000
-
GET_ACCOUNTS_ACCOUNT_CAPABILITIES_CAPABILITY_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_CAPABILITIES_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_MAX_LENGTH_FOR_OBJECT =
5000
-
GET_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_VALID_VALUES_FOR_OBJECT =
String.static_array("bank_account", "card")
-
GET_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_ENDING_BEFORE =
5000
-
GET_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_STARTING_AFTER =
5000
-
GET_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_ACCOUNT =
5000
-
GET_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_PERSON =
5000
-
POST_ACCOUNTS_ACCOUNT_CAPABILITIES_CAPABILITY_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT_HOLDER_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT_HOLDER_TYPE =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ACCOUNT_TYPE =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_CITY =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_COUNTRY =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_LINE1 =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_LINE2 =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_STATE =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_ADDRESS_ZIP =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_EXP_MONTH =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_EXP_YEAR =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_MAX_LENGTH_FOR_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_VALID_VALUES_FOR_ACCOUNT_HOLDER_TYPE =
String.static_array("", "company", "individual")
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_ID_VALID_VALUES_FOR_ACCOUNT_TYPE =
String.static_array("checking", "futsu", "savings", "toza")
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_EXTERNAL_ACCOUNTS_MAX_LENGTH_FOR_EXTERNAL_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_LOGIN_LINKS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_ACCOUNT_TOKEN =
5000
-
POST_ACCOUNTS_ACCOUNT_MAX_LENGTH_FOR_EXTERNAL_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_FIRST_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_FIRST_NAME_KANA =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_FIRST_NAME_KANJI =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_ID_NUMBER =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_ID_NUMBER_SECONDARY =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_LAST_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_LAST_NAME_KANA =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_LAST_NAME_KANJI =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_MAIDEN_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_NATIONALITY =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_PERSON_TOKEN =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_MAX_LENGTH_FOR_POLITICAL_EXPOSURE =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_FIRST_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_FIRST_NAME_KANA =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_FIRST_NAME_KANJI =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_ID_NUMBER =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_ID_NUMBER_SECONDARY =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_LAST_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_LAST_NAME_KANA =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_LAST_NAME_KANJI =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_MAIDEN_NAME =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_NATIONALITY =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_PERSON =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_PERSON_TOKEN =
5000
-
POST_ACCOUNTS_ACCOUNT_PERSONS_PERSON_MAX_LENGTH_FOR_POLITICAL_EXPOSURE =
5000
-
POST_ACCOUNTS_ACCOUNT_REJECT_MAX_LENGTH_FOR_ACCOUNT =
5000
-
POST_ACCOUNTS_ACCOUNT_REJECT_MAX_LENGTH_FOR_REASON =
5000
-
POST_ACCOUNTS_ACCOUNT_VALID_VALUES_FOR_BUSINESS_TYPE =
String.static_array("company", "government_entity", "individual", "non_profit")
-
POST_ACCOUNTS_MAX_LENGTH_FOR_ACCOUNT_TOKEN =
5000
-
POST_ACCOUNTS_MAX_LENGTH_FOR_COUNTRY =
5000
-
POST_ACCOUNTS_MAX_LENGTH_FOR_EXTERNAL_ACCOUNT =
5000
-
POST_ACCOUNTS_VALID_VALUES_FOR__TYPE =
String.static_array("custom", "express", "standard")
-
POST_ACCOUNTS_VALID_VALUES_FOR_BUSINESS_TYPE =
String.static_array("company", "government_entity", "individual", "non_profit")
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_delete_accounts_account(*, account : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_capabilities(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_external_accounts(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_persons(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, relationship : Stripe::AllPeopleRelationshipSpecs | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts(*, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, controller : Stripe::ControllerSpecs | Nil = nil, country : String | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecs | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil, _type : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account(*, account : String | Nil = nil, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecsUpdate | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(String) | Nil = nil, requested : Bool | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_external_accounts(*, account : String | Nil = nil, external_account : String | Nil = nil, default_for_currency : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, account_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, default_for_currency : Bool | Nil = nil, documents : Stripe::ExternalAccountDocumentsParam | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_login_links(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_persons(*, account : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_accounts_account_reject(*, account : String | Nil = nil, reason : String | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_accounts_account(*, account : String | Nil = nil) : Stripe::DeletedAccount
With Connect, you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts.
-
#delete_accounts_account(*, account : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>With <a href="/connect">Connect</a>, you can delete accounts you manage.</p> <p>Test-mode accounts can be deleted at any time.</p> <p>Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts.
-
#delete_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil) : Stripe::DeletedExternalAccount
Delete a specified external account for a given account.
@required @param account [String?] @required @param id [String?] @return [Stripe::DeletedExternalAccount] -
#delete_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Delete a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @return nil
-
#delete_accounts_account_external_accounts_id_with_http_info(*, account : String | Nil = nil, id : String | Nil = nil) : Tuple(Stripe::DeletedExternalAccount, Int32, Hash(String, Array(String) | String))
<p>Delete a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @return [Tuple(Stripe::DeletedExternalAccount, Integer, Hash)] Stripe::DeletedExternalAccount, response status code and response headers
-
#delete_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil) : Stripe::DeletedPerson
Deletes an existing person’s relationship to the account’s legal entity.
-
#delete_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Deletes an existing person’s relationship to the account’s legal entity.
-
#delete_accounts_account_persons_person_with_http_info(*, account : String | Nil = nil, person : String | Nil = nil) : Tuple(Stripe::DeletedPerson, Int32, Hash(String, Array(String) | String))
<p>Deletes an existing person’s relationship to the account’s legal entity.
-
#delete_accounts_account_with_http_info(*, account : String | Nil = nil) : Tuple(Stripe::DeletedAccount, Int32, Hash(String, Array(String) | String))
<p>With <a href="/connect">Connect</a>, you can delete accounts you manage.</p> <p>Test-mode accounts can be deleted at any time.</p> <p>Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts.
-
#get_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::AccountList
Returns a list of accounts connected to your platform via Connect.
-
#get_accounts(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>.
-
#get_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Account
Retrieves the details of an account.
@required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_accounts_account(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the details of an account.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_capabilities(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ListAccountCapability
Returns a list of capabilities associated with the account.
-
#get_accounts_account_capabilities(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of capabilities associated with the account.
-
#get_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Capability
Retrieves information about the specified Account Capability.
@required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves information about the specified Account Capability.</p> @required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_capabilities_capability_with_http_info(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Capability, Int32, Hash(String, Array(String) | String))
<p>Retrieves information about the specified Account Capability.</p> @required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_capabilities_with_http_info(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ListAccountCapability, Int32, Hash(String, Array(String) | String))
<p>Returns a list of capabilities associated with the account.
-
#get_accounts_account_external_accounts(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ExternalAccountList
List external accounts for an account.
@required @param account [String?] @optional @param ending_before [String?] A cursor for use in pagination. -
#get_accounts_account_external_accounts(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>List external accounts for an account.</p> @required @param account [String?] @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ExternalAccount
Retrieve a specified external account for a given account.
@required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieve a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_external_accounts_id_with_http_info(*, account : String | Nil = nil, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ExternalAccount, Int32, Hash(String, Array(String) | String))
<p>Retrieve a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_external_accounts_with_http_info(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, object : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ExternalAccountList, Int32, Hash(String, Array(String) | String))
<p>List external accounts for an account.</p> @required @param account [String?] @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_accounts_account_persons(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, relationship : Stripe::AllPeopleRelationshipSpecs | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::PersonList
Returns a list of people associated with the account’s legal entity.
-
#get_accounts_account_persons(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, relationship : Stripe::AllPeopleRelationshipSpecs | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of people associated with the account’s legal entity.
-
#get_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::Person
Retrieves an existing person.
@required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_persons_person_with_http_info(*, account : String | Nil = nil, person : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Person, Int32, Hash(String, Array(String) | String))
<p>Retrieves an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_account_persons_with_http_info(*, account : String | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, relationship : Stripe::AllPeopleRelationshipSpecs | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::PersonList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of people associated with the account’s legal entity.
-
#get_accounts_account_with_http_info(*, account : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::Account, Int32, Hash(String, Array(String) | String))
<p>Retrieves the details of an account.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_accounts_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::AccountList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>.
-
#post_accounts(*, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, controller : Stripe::ControllerSpecs | Nil = nil, country : String | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecs | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil, _type : String | Nil = nil) : Stripe::Account
With Connect, you can create Stripe accounts for your users.
-
#post_accounts(*, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, controller : Stripe::ControllerSpecs | Nil = nil, country : String | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecs | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil, _type : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users.
-
#post_accounts_account(*, account : String | Nil = nil, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecsUpdate | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil) : Stripe::Account
Updates a connected account by setting the values of the parameters passed.
-
#post_accounts_account(*, account : String | Nil = nil, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecsUpdate | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed.
-
#post_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(String) | Nil = nil, requested : Bool | Nil = nil) : Stripe::Capability
Updates an existing Account Capability.
-
#post_accounts_account_capabilities_capability(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(String) | Nil = nil, requested : Bool | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing Account Capability.
-
#post_accounts_account_capabilities_capability_with_http_info(*, account : String | Nil = nil, capability : String | Nil = nil, expand : Array(String) | Nil = nil, requested : Bool | Nil = nil) : Tuple(Stripe::Capability, Int32, Hash(String, Array(String) | String))
<p>Updates an existing Account Capability.
-
#post_accounts_account_external_accounts(*, account : String | Nil = nil, external_account : String | Nil = nil, default_for_currency : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Stripe::ExternalAccount
Create an external account for a given account.
@required @param account [String?] @required @param external_account [String?] Please refer to full [documentation](https://stripe.com/docs/api) instead. -
#post_accounts_account_external_accounts(*, account : String | Nil = nil, external_account : String | Nil = nil, default_for_currency : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Create an external account for a given account.</p> @required @param account [String?] @required @param external_account [String?] Please refer to full documentation instead.
-
#post_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, account_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, default_for_currency : Bool | Nil = nil, documents : Stripe::ExternalAccountDocumentsParam | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil) : Stripe::ExternalAccount
Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency.
-
#post_accounts_account_external_accounts_id(*, account : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, account_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, default_for_currency : Bool | Nil = nil, documents : Stripe::ExternalAccountDocumentsParam | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency.
-
#post_accounts_account_external_accounts_id_with_http_info(*, account : String | Nil = nil, id : String | Nil = nil, account_holder_name : String | Nil = nil, account_holder_type : String | Nil = nil, account_type : String | Nil = nil, address_city : String | Nil = nil, address_country : String | Nil = nil, address_line1 : String | Nil = nil, address_line2 : String | Nil = nil, address_state : String | Nil = nil, address_zip : String | Nil = nil, default_for_currency : Bool | Nil = nil, documents : Stripe::ExternalAccountDocumentsParam | Nil = nil, exp_month : String | Nil = nil, exp_year : String | Nil = nil, expand : Array(String) | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, name : String | Nil = nil) : Tuple(Stripe::ExternalAccount, Int32, Hash(String, Array(String) | String))
<p>Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency.
-
#post_accounts_account_external_accounts_with_http_info(*, account : String | Nil = nil, external_account : String | Nil = nil, default_for_currency : Bool | Nil = nil, expand : Array(String) | Nil = nil, metadata : Hash(String, String) | Nil = nil) : Tuple(Stripe::ExternalAccount, Int32, Hash(String, Array(String) | String))
<p>Create an external account for a given account.</p> @required @param account [String?] @required @param external_account [String?] Please refer to full documentation instead.
-
#post_accounts_account_login_links(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::LoginLink
Creates a single-use login link for a connected account to access the Express Dashboard.
You can only create login links for accounts that use the Express Dashboard and are connected to your platform.
@required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. -
#post_accounts_account_login_links(*, account : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a single-use login link for a connected account to access the Express Dashboard.</p> <p><strong>You can only create login links for accounts that use the <a href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform</strong>.</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_accounts_account_login_links_with_http_info(*, account : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::LoginLink, Int32, Hash(String, Array(String) | String))
<p>Creates a single-use login link for a connected account to access the Express Dashboard.</p> <p><strong>You can only create login links for accounts that use the <a href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform</strong>.</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
-
#post_accounts_account_persons(*, account : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Stripe::Person
Creates a new person.
@required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. -
#post_accounts_account_persons(*, account : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new person.</p> @required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address.
-
#post_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Stripe::Person
Updates an existing person.
@required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. -
#post_accounts_account_persons_person(*, account : String | Nil = nil, person : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address.
-
#post_accounts_account_persons_person_with_http_info(*, account : String | Nil = nil, person : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Tuple(Stripe::Person, Int32, Hash(String, Array(String) | String))
<p>Updates an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address.
-
#post_accounts_account_persons_with_http_info(*, account : String | Nil = nil, additional_tos_acceptances : Stripe::PersonAdditionalTosAcceptancesSpecs | Nil = nil, address : Stripe::LegalEntityAndKycAddressSpecs | Nil = nil, address_kana : Stripe::JapanAddressKanaSpecs | Nil = nil, address_kanji : Stripe::JapanAddressKanjiSpecs | Nil = nil, dob : Stripe::PostAccountsAccountPersonsRequestDob | Nil = nil, documents : Stripe::PersonDocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, first_name : String | Nil = nil, first_name_kana : String | Nil = nil, first_name_kanji : String | Nil = nil, full_name_aliases : Stripe::PostAccountsAccountPersonsRequestFullNameAliases | Nil = nil, gender : String | Nil = nil, id_number : String | Nil = nil, id_number_secondary : String | Nil = nil, last_name : String | Nil = nil, last_name_kana : String | Nil = nil, last_name_kanji : String | Nil = nil, maiden_name : String | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, nationality : String | Nil = nil, person_token : String | Nil = nil, phone : String | Nil = nil, political_exposure : String | Nil = nil, registered_address : Stripe::AddressSpecs | Nil = nil, relationship : Stripe::RelationshipSpecs | Nil = nil, ssn_last_4 : String | Nil = nil, verification : Stripe::PersonVerificationSpecs | Nil = nil) : Tuple(Stripe::Person, Int32, Hash(String, Array(String) | String))
<p>Creates a new person.</p> @required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address.
-
#post_accounts_account_reject(*, account : String | Nil = nil, reason : String | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::Account
With Connect, you can reject accounts that you have flagged as suspicious.
Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.
-
#post_accounts_account_reject(*, account : String | Nil = nil, reason : String | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious.</p> <p>Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.
-
#post_accounts_account_reject_with_http_info(*, account : String | Nil = nil, reason : String | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::Account, Int32, Hash(String, Array(String) | String))
<p>With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious.</p> <p>Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected.
-
#post_accounts_account_with_http_info(*, account : String | Nil = nil, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecsUpdate | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil) : Tuple(Stripe::Account, Int32, Hash(String, Array(String) | String))
<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed.
-
#post_accounts_with_http_info(*, account_token : String | Nil = nil, business_profile : Stripe::BusinessProfileSpecs | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::CapabilitiesParam | Nil = nil, company : Stripe::CompanySpecs | Nil = nil, controller : Stripe::ControllerSpecs | Nil = nil, country : String | Nil = nil, default_currency : String | Nil = nil, documents : Stripe::DocumentsSpecs | Nil = nil, email : String | Nil = nil, expand : Array(String) | Nil = nil, external_account : String | Nil = nil, individual : Stripe::IndividualSpecs | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, settings : Stripe::SettingsSpecs | Nil = nil, tos_acceptance : Stripe::TosAcceptanceSpecs | Nil = nil, _type : String | Nil = nil) : Tuple(Stripe::Account, Int32, Hash(String, Array(String) | String))
<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
With Connect, you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.
If you want to delete your own account, use the account information tab in your account settings instead.
@required @param account [String?] @return [Stripe::DeletedAccount]<p>With <a href="/connect">Connect</a>, you can delete accounts you manage.</p> <p>Test-mode accounts can be deleted at any time.</p> <p>Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all <a href="/api/balance/balance_object">balances</a> are zero.</p> <p>If you want to delete your own account, use the <a href="https://dashboard.stripe.com/settings/account">account information tab in your account settings</a> instead.</p> @required @param account [String?] @return nil
Delete a specified external account for a given account.
@required @param account [String?] @required @param id [String?] @return [Stripe::DeletedExternalAccount]<p>Delete a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @return nil
<p>Delete a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @return [Tuple(Stripe::DeletedExternalAccount, Integer, Hash)] Stripe::DeletedExternalAccount, response status code and response headers
Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener
. If your integration is using the executive
parameter, you cannot delete the only verified executive
on file.
<p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p> @required @param account [String?] @required @param person [String?] @return nil
<p>Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the <code>account_opener</code>. If your integration is using the <code>executive</code> parameter, you cannot delete the only verified <code>executive</code> on file.</p> @required @param account [String?] @required @param person [String?] @return [Tuple(Stripe::DeletedPerson, Integer, Hash)] Stripe::DeletedPerson, response status code and response headers
<p>With <a href="/connect">Connect</a>, you can delete accounts you manage.</p> <p>Test-mode accounts can be deleted at any time.</p> <p>Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all <a href="/api/balance/balance_object">balances</a> are zero.</p> <p>If you want to delete your own account, use the <a href="https://dashboard.stripe.com/settings/account">account information tab in your account settings</a> instead.</p> @required @param account [String?] @return [Tuple(Stripe::DeletedAccount, Integer, Hash)] Stripe::DeletedAccount, response status code and response headers
Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return connected accounts that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::AccountList]<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return connected accounts that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves the details of an account.
@required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Account]<p>Retrieves the details of an account.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
@required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ListAccountCapability]<p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
Retrieves information about the specified Account Capability.
@required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Capability]<p>Retrieves information about the specified Account Capability.</p> @required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves information about the specified Account Capability.</p> @required @param account [String?] @required @param capability [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Capability, Integer, Hash)] Stripe::Capability, response status code and response headers
<p>Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ListAccountCapability, Integer, Hash)] Stripe::ListAccountCapability, response status code and response headers
List external accounts for an account.
@required @param account [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param object [String?] Filter external accounts according to a particular object type. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ExternalAccountList]<p>List external accounts for an account.</p>
@required @param account [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param object [String?] Filter external accounts according to a particular object type.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieve a specified external account for a given account.
@required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ExternalAccount]<p>Retrieve a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieve a specified external account for a given account.</p> @required @param account [String?] @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ExternalAccount, Integer, Hash)] Stripe::ExternalAccount, response status code and response headers
<p>List external accounts for an account.</p>
@required @param account [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param object [String?] Filter external accounts according to a particular object type.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::ExternalAccountList, Integer, Hash)] Stripe::ExternalAccountList, response status code and response headers
Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
@required @param account [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param relationship [Stripe::AllPeopleRelationshipSpecs?] Filters on the list of people returned based on the person's relationship to the account's company. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PersonList]<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
@required @param account [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param relationship [Stripe::AllPeopleRelationshipSpecs?] Filters on the list of people returned based on the person's relationship to the account's company.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return nil
Retrieves an existing person.
@required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::Person]<p>Retrieves an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Person, Integer, Hash)] Stripe::Person, response status code and response headers
<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
@required @param account [String?]
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param relationship [Stripe::AllPeopleRelationshipSpecs?] Filters on the list of people returned based on the person's relationship to the account's company.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::PersonList, Integer, Hash)] Stripe::PersonList, response status code and response headers
<p>Retrieves the details of an account.</p> @required @param account [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::Account, Integer, Hash)] Stripe::Account, response status code and response headers
<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
@optional @param ending_before [String?] A cursor for use in pagination. ending_before
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar
, your subsequent call can include ending_before=obj_bar
in order to fetch the previous page of the list.
@optional @param starting_after [String?] A cursor for use in pagination. starting_after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo
, your subsequent call can include starting_after=obj_foo
in order to fetch the next page of the list.
@optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return connected accounts that were created during the given date interval.
@optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::AccountList, Integer, Hash)] Stripe::AccountList, response status code and response headers
With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.
If you’ve already collected information for your connected accounts, you can prefill that information when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.
@optional @param account_token [String?] An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. @optional @param business_profile [Stripe::BusinessProfileSpecs?] @optional @param business_type [String?] The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @optional @param capabilities [Stripe::CapabilitiesParam?] @optional @param company [Stripe::CompanySpecs?] @optional @param controller [Stripe::ControllerSpecs?] @optional @param country [String?] The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported. @optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). @optional @param documents [Stripe::DocumentsSpecs?] @optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param external_account [String?] A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @optional @param individual [Stripe::IndividualSpecs?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param settings [Stripe::SettingsSpecs?] @optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?] @optional @param _type [String?] The type of Stripe account to create. May be one of `custom`, `express` or `standard`. @return [Stripe::Account]
<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p> <p>If you’ve already collected information for your connected accounts, you <a href="/docs/connect/best-practices#onboarding">can prefill that information</a> when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.</p>
@optional @param account_token [String?] An account token, used to securely provide details to the account.
@optional @param business_profile [Stripe::BusinessProfileSpecs?]
@optional @param business_type [String?] The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param capabilities [Stripe::CapabilitiesParam?]
@optional @param company [Stripe::CompanySpecs?]
@optional @param controller [Stripe::ControllerSpecs?]
@optional @param country [String?] The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA
as the country for the account being created. Available countries include Stripe's global markets as well as countries where cross-border payouts are supported.
@optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
@optional @param documents [Stripe::DocumentsSpecs?]
@optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application
, which includes Custom accounts, Stripe doesn't email the account without your consent.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param external_account [String?] A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account
parameter for bank account creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param individual [Stripe::IndividualSpecs?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param settings [Stripe::SettingsSpecs?]
@optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?]
@optional @param _type [String?] The type of Stripe account to create. May be one of custom
, express
or standard
.
@return nil
Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.
For accounts where controller.requirement_collection is application
, which includes Custom accounts, you can update any information on the account.
For accounts where controller.requirement_collection is stripe
, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.
To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.
@required @param account [String?] @optional @param account_token [String?] An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. @optional @param business_profile [Stripe::BusinessProfileSpecs?] @optional @param business_type [String?] The business type. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @optional @param capabilities [Stripe::CapabilitiesParam?] @optional @param company [Stripe::CompanySpecs?] @optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://docs.stripe.com/payouts). @optional @param documents [Stripe::DocumentsSpecs?] @optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param external_account [String?] A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. @optional @param individual [Stripe::IndividualSpecs?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param settings [Stripe::SettingsSpecsUpdate?] @optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?] @return [Stripe::Account]
<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p> <p>For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts, you can update any information on the account.</p> <p>For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>stripe</code>, which includes Standard and Express accounts, you can update all information until you create an <a href="/api/account_links">Account Link</a> or <a href="/api/account_sessions">Account Session</a> to start Connect onboarding, after which some properties can no longer be updated.</p> <p>To update your own account, use the <a href="https://dashboard.stripe.com/settings/account">Dashboard</a>. Refer to our <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn more about updating accounts.</p>
@required @param account [String?]
@optional @param account_token [String?] An account token, used to securely provide details to the account.
@optional @param business_profile [Stripe::BusinessProfileSpecs?]
@optional @param business_type [String?] The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param capabilities [Stripe::CapabilitiesParam?]
@optional @param company [Stripe::CompanySpecs?]
@optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
@optional @param documents [Stripe::DocumentsSpecs?]
@optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application
, which includes Custom accounts, Stripe doesn't email the account without your consent.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param external_account [String?] A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account
parameter for bank account creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param individual [Stripe::IndividualSpecs?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param settings [Stripe::SettingsSpecsUpdate?]
@optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?]
@return nil
Updates an existing Account Capability. Request or remove a capability by updating its requested
parameter.
<p>Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.</p>
@required @param account [String?]
@required @param capability [String?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param requested [Bool?] To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the requirements
arrays. If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
@return nil
<p>Updates an existing Account Capability. Request or remove a capability by updating its <code>requested</code> parameter.</p>
@required @param account [String?]
@required @param capability [String?]
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param requested [Bool?] To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the requirements
arrays. If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
@return [Tuple(Stripe::Capability, Integer, Hash)] Stripe::Capability, response status code and response headers
Create an external account for a given account.
@required @param account [String?] @required @param external_account [String?] Please refer to full [documentation](https://stripe.com/docs/api) instead. @optional @param default_for_currency [Bool?] When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Stripe::ExternalAccount]<p>Create an external account for a given account.</p> @required @param account [String?] @required @param external_account [String?] Please refer to full documentation instead. @optional @param default_for_currency [Bool?] When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return nil
Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.
You can only update bank accounts when account.controller.requirement_collection is application
, which includes Custom accounts.
You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.
@required @param account [String?] @required @param id [String?] @optional @param account_holder_name [String?] The name of the person or business that owns the bank account. @optional @param account_holder_type [String?] The type of entity that holds the account. This can be either `individual` or `company`. @optional @param account_type [String?] The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. @optional @param address_city [String?] City/District/Suburb/Town/Village. @optional @param address_country [String?] Billing address country, if provided when creating card. @optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name). @optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building). @optional @param address_state [String?] State/County/Province/Region. @optional @param address_zip [String?] ZIP or postal code. @optional @param default_for_currency [Bool?] When set to true, this becomes the default external account for its currency. @optional @param documents [Stripe::ExternalAccountDocumentsParam?] @optional @param exp_month [String?] Two digit number representing the card’s expiration month. @optional @param exp_year [String?] Four digit number representing the card’s expiration year. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param name [String?] Cardholder name. @return [Stripe::ExternalAccount]<p>Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> <p>You can only update bank accounts when <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href="/connect/custom-accounts">Custom accounts</a>.</p> <p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
@required @param account [String?]
@required @param id [String?]
@optional @param account_holder_name [String?] The name of the person or business that owns the bank account.
@optional @param account_holder_type [String?] The type of entity that holds the account. This can be either individual
or company
.
@optional @param account_type [String?] The bank account type. This can only be checking
or savings
in most countries. In Japan, this can only be futsu
or toza
.
@optional @param address_city [String?] City/District/Suburb/Town/Village.
@optional @param address_country [String?] Billing address country, if provided when creating card.
@optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name).
@optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building).
@optional @param address_state [String?] State/County/Province/Region.
@optional @param address_zip [String?] ZIP or postal code.
@optional @param default_for_currency [Bool?] When set to true, this becomes the default external account for its currency.
@optional @param documents [Stripe::ExternalAccountDocumentsParam?]
@optional @param exp_month [String?] Two digit number representing the card’s expiration month.
@optional @param exp_year [String?] Four digit number representing the card’s expiration year.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param name [String?] Cardholder name.
@return nil
<p>Updates the metadata, account holder name, account holder type of a bank account belonging to a connected account and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p> <p>You can only update bank accounts when <a href="/api/accounts/object#account_object-controller-requirement_collection">account.controller.requirement_collection</a> is <code>application</code>, which includes <a href="/connect/custom-accounts">Custom accounts</a>.</p> <p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>
@required @param account [String?]
@required @param id [String?]
@optional @param account_holder_name [String?] The name of the person or business that owns the bank account.
@optional @param account_holder_type [String?] The type of entity that holds the account. This can be either individual
or company
.
@optional @param account_type [String?] The bank account type. This can only be checking
or savings
in most countries. In Japan, this can only be futsu
or toza
.
@optional @param address_city [String?] City/District/Suburb/Town/Village.
@optional @param address_country [String?] Billing address country, if provided when creating card.
@optional @param address_line1 [String?] Address line 1 (Street address/PO Box/Company name).
@optional @param address_line2 [String?] Address line 2 (Apartment/Suite/Unit/Building).
@optional @param address_state [String?] State/County/Province/Region.
@optional @param address_zip [String?] ZIP or postal code.
@optional @param default_for_currency [Bool?] When set to true, this becomes the default external account for its currency.
@optional @param documents [Stripe::ExternalAccountDocumentsParam?]
@optional @param exp_month [String?] Two digit number representing the card’s expiration month.
@optional @param exp_year [String?] Four digit number representing the card’s expiration year.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param name [String?] Cardholder name.
@return [Tuple(Stripe::ExternalAccount, Integer, Hash)] Stripe::ExternalAccount, response status code and response headers
<p>Create an external account for a given account.</p> @required @param account [String?] @required @param external_account [String?] Please refer to full documentation instead. @optional @param default_for_currency [Bool?] When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Hash(String, String)?] @return [Tuple(Stripe::ExternalAccount, Integer, Hash)] Stripe::ExternalAccount, response status code and response headers
Creates a single-use login link for a connected account to access the Express Dashboard.
You can only create login links for accounts that use the Express Dashboard and are connected to your platform.
@required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::LoginLink]<p>Creates a single-use login link for a connected account to access the Express Dashboard.</p> <p><strong>You can only create login links for accounts that use the <a href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform</strong>.</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil
<p>Creates a single-use login link for a connected account to access the Express Dashboard.</p> <p><strong>You can only create login links for accounts that use the <a href="/connect/express-dashboard">Express Dashboard</a> and are connected to your platform</strong>.</p> @required @param account [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::LoginLink, Integer, Hash)] Stripe::LoginLink, response status code and response headers
Creates a new person.
@required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \\\"male\\\" or \\\"female\\\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \\\"XX\\\" if unavailable. @optional @param person_token [String?] A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return [Stripe::Person]<p>Creates a new person.</p> @required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \"male\" or \"female\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or \"XX\" if unavailable. @optional @param person_token [String?] A person token, used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return nil
Updates an existing person.
@required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \\\"male\\\" or \\\"female\\\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or \\\"XX\\\" if unavailable. @optional @param person_token [String?] A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return [Stripe::Person]<p>Updates an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \"male\" or \"female\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or \"XX\" if unavailable. @optional @param person_token [String?] A person token, used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return nil
<p>Updates an existing person.</p> @required @param account [String?] @required @param person [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \"male\" or \"female\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or \"XX\" if unavailable. @optional @param person_token [String?] A person token, used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return [Tuple(Stripe::Person, Integer, Hash)] Stripe::Person, response status code and response headers
<p>Creates a new person.</p> @required @param account [String?] @optional @param additional_tos_acceptances [Stripe::PersonAdditionalTosAcceptancesSpecs?] @optional @param address [Stripe::LegalEntityAndKycAddressSpecs?] @optional @param address_kana [Stripe::JapanAddressKanaSpecs?] @optional @param address_kanji [Stripe::JapanAddressKanjiSpecs?] @optional @param dob [Stripe::PostAccountsAccountPersonsRequestDob?] @optional @param documents [Stripe::PersonDocumentsSpecs?] @optional @param email [String?] The person's email address. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param first_name [String?] The person's first name. @optional @param first_name_kana [String?] The Kana variation of the person's first name (Japan only). @optional @param first_name_kanji [String?] The Kanji variation of the person's first name (Japan only). @optional @param full_name_aliases [Stripe::PostAccountsAccountPersonsRequestFullNameAliases?] @optional @param gender [String?] The person's gender (International regulations require either \"male\" or \"female\"). @optional @param id_number [String?] The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param id_number_secondary [String?] The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a PII token provided by Stripe.js. @optional @param last_name [String?] The person's last name. @optional @param last_name_kana [String?] The Kana variation of the person's last name (Japan only). @optional @param last_name_kanji [String?] The Kanji variation of the person's last name (Japan only). @optional @param maiden_name [String?] The person's maiden name. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @optional @param nationality [String?] The country where the person is a national. Two-letter country code (ISO 3166-1 alpha-2), or \"XX\" if unavailable. @optional @param person_token [String?] A person token, used to securely provide details to the person. @optional @param phone [String?] The person's phone number. @optional @param political_exposure [String?] Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. @optional @param registered_address [Stripe::AddressSpecs?] @optional @param relationship [Stripe::RelationshipSpecs?] @optional @param ssn_last_4 [String?] The last four digits of the person's Social Security number (U.S. only). @optional @param verification [Stripe::PersonVerificationSpecs?] @return [Tuple(Stripe::Person, Integer, Hash)] Stripe::Person, response status code and response headers
With Connect, you can reject accounts that you have flagged as suspicious.
Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
@required @param account [String?] @required @param reason [String?] The reason for rejecting the account. Can be `fraud`, `terms_of_service`, or `other`. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::Account]<p>With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious.</p> <p>Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.</p>
@required @param account [String?]
@required @param reason [String?] The reason for rejecting the account. Can be fraud
, terms_of_service
, or other
.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@return nil
<p>With <a href="/connect">Connect</a>, you can reject accounts that you have flagged as suspicious.</p> <p>Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.</p>
@required @param account [String?]
@required @param reason [String?] The reason for rejecting the account. Can be fraud
, terms_of_service
, or other
.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@return [Tuple(Stripe::Account, Integer, Hash)] Stripe::Account, response status code and response headers
<p>Updates a <a href="/connect/accounts">connected account</a> by setting the values of the parameters passed. Any parameters not provided are left unchanged.</p> <p>For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>application</code>, which includes Custom accounts, you can update any information on the account.</p> <p>For accounts where <a href="/api/accounts/object#account_object-controller-requirement_collection">controller.requirement_collection</a> is <code>stripe</code>, which includes Standard and Express accounts, you can update all information until you create an <a href="/api/account_links">Account Link</a> or <a href="/api/account_sessions">Account Session</a> to start Connect onboarding, after which some properties can no longer be updated.</p> <p>To update your own account, use the <a href="https://dashboard.stripe.com/settings/account">Dashboard</a>. Refer to our <a href="/docs/connect/updating-accounts">Connect</a> documentation to learn more about updating accounts.</p>
@required @param account [String?]
@optional @param account_token [String?] An account token, used to securely provide details to the account.
@optional @param business_profile [Stripe::BusinessProfileSpecs?]
@optional @param business_type [String?] The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param capabilities [Stripe::CapabilitiesParam?]
@optional @param company [Stripe::CompanySpecs?]
@optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
@optional @param documents [Stripe::DocumentsSpecs?]
@optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application
, which includes Custom accounts, Stripe doesn't email the account without your consent.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param external_account [String?] A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account
parameter for bank account creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param individual [Stripe::IndividualSpecs?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param settings [Stripe::SettingsSpecsUpdate?]
@optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?]
@return [Tuple(Stripe::Account, Integer, Hash)] Stripe::Account, response status code and response headers
<p>With <a href="/docs/connect">Connect</a>, you can create Stripe accounts for your users. To do this, you’ll first need to <a href="https://dashboard.stripe.com/account/applications/settings">register your platform</a>.</p> <p>If you’ve already collected information for your connected accounts, you <a href="/docs/connect/best-practices#onboarding">can prefill that information</a> when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.</p>
@optional @param account_token [String?] An account token, used to securely provide details to the account.
@optional @param business_profile [Stripe::BusinessProfileSpecs?]
@optional @param business_type [String?] The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param capabilities [Stripe::CapabilitiesParam?]
@optional @param company [Stripe::CompanySpecs?]
@optional @param controller [Stripe::ControllerSpecs?]
@optional @param country [String?] The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use CA
as the country for the account being created. Available countries include Stripe's global markets as well as countries where cross-border payouts are supported.
@optional @param default_currency [String?] Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.
@optional @param documents [Stripe::DocumentsSpecs?]
@optional @param email [String?] The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is application
, which includes Custom accounts, Stripe doesn't email the account without your consent.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param external_account [String?] A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the external_account
parameter for bank account creation.
By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application
, which includes Custom accounts.
@optional @param individual [Stripe::IndividualSpecs?]
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@optional @param settings [Stripe::SettingsSpecs?]
@optional @param tos_acceptance [Stripe::TosAcceptanceSpecs?]
@optional @param _type [String?] The type of Stripe account to create. May be one of custom
, express
or standard
.
@return [Tuple(Stripe::Account, Integer, Hash)] Stripe::Account, response status code and response headers