POST /v1/accounts/{account}
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.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
account |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
business_type |
String | No |
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 Possible values:
|
external_account |
String | No |
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 |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
No |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
tos_acceptance |
Object | No |
Details on the account's acceptance of the Stripe Services Agreement. This property can only be updated for accounts where controller.requirement_collection is |
tos_acceptance.service_agreement |
String | No | |
tos_acceptance.user_agent |
String | No | |
tos_acceptance.ip |
String | No | |
tos_acceptance.date |
Integer | No | |
documents |
Object | No |
Documents that may be submitted to satisfy various informational requests. |
documents.company_license |
Object | No | |
documents.company_license.files[] |
Array | No | |
documents.company_registration_verification |
Object | No | |
documents.company_registration_verification.files[] |
Array | No | |
documents.proof_of_address |
Object | No | |
documents.proof_of_address.files[] |
Array | No | |
documents.proof_of_registration |
Object | No | |
documents.proof_of_registration.files[] |
Array | No | |
documents.bank_account_ownership_verification |
Object | No | |
documents.bank_account_ownership_verification.files[] |
Array | No | |
documents.company_memorandum_of_association |
Object | No | |
documents.company_memorandum_of_association.files[] |
Array | No | |
documents.company_tax_id_verification |
Object | No | |
documents.company_tax_id_verification.files[] |
Array | No | |
documents.company_ministerial_decree |
Object | No | |
documents.company_ministerial_decree.files[] |
Array | No | |
documents.proof_of_ultimate_beneficial_ownership |
Object | No | |
documents.proof_of_ultimate_beneficial_ownership.files[] |
Array | No | |
account_token |
String | No |
An account token, used to securely provide details to the account. |
email |
String | No |
The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is |
individual |
Object | No |
Information about the person represented by the account. This field is null unless |
individual.last_name_kana |
String | No | |
individual.full_name_aliases |
No | ||
individual.first_name |
String | No | |
individual.metadata |
No | ||
individual.relationship |
Object | No | |
individual.relationship.percent_ownership |
No | ||
individual.relationship.executive |
Boolean | No | |
individual.relationship.title |
String | No | |
individual.relationship.director |
Boolean | No | |
individual.relationship.owner |
Boolean | No | |
individual.dob |
No | ||
individual.id_number |
String | No | |
individual.first_name_kana |
String | No | |
individual.id_number_secondary |
String | No | |
individual.political_exposure |
String | No |
Possible values:
|
individual.last_name_kanji |
String | No | |
individual.email |
String | No | |
individual.gender |
String | No | |
individual.address_kanji |
Object | No | |
individual.address_kanji.line2 |
String | No | |
individual.address_kanji.line1 |
String | No | |
individual.address_kanji.town |
String | No | |
individual.address_kanji.postal_code |
String | No | |
individual.address_kanji.country |
String | No | |
individual.address_kanji.state |
String | No | |
individual.address_kanji.city |
String | No | |
individual.last_name |
String | No | |
individual.maiden_name |
String | No | |
individual.ssn_last_4 |
String | No | |
individual.address_kana |
Object | No | |
individual.address_kana.line2 |
String | No | |
individual.address_kana.line1 |
String | No | |
individual.address_kana.town |
String | No | |
individual.address_kana.postal_code |
String | No | |
individual.address_kana.country |
String | No | |
individual.address_kana.state |
String | No | |
individual.address_kana.city |
String | No | |
individual.verification |
Object | No | |
individual.verification.additional_document |
Object | No | |
individual.verification.additional_document.back |
String | No | |
individual.verification.additional_document.front |
String | No | |
individual.verification.document |
Object | No | |
individual.verification.document.back |
String | No | |
individual.verification.document.front |
String | No | |
individual.phone |
String | No | |
individual.registered_address |
Object | No | |
individual.registered_address.line2 |
String | No | |
individual.registered_address.line1 |
String | No | |
individual.registered_address.postal_code |
String | No | |
individual.registered_address.country |
String | No | |
individual.registered_address.state |
String | No | |
individual.registered_address.city |
String | No | |
individual.first_name_kanji |
String | No | |
individual.address |
Object | No | |
individual.address.line2 |
String | No | |
individual.address.line1 |
String | No | |
individual.address.postal_code |
String | No | |
individual.address.country |
String | No | |
individual.address.state |
String | No | |
individual.address.city |
String | No | |
groups |
Object | No |
A hash of account group type to tokens. These are account groups this account should be added to. |
groups.payments_pricing |
No | ||
company |
Object | No |
Information about the company or business. This field is available for any |
company.tax_id |
String | No | |
company.directors_provided |
Boolean | No | |
company.ownership_exemption_reason |
String | No |
Possible values:
|
company.export_license_id |
String | No | |
company.owners_provided |
Boolean | No | |
company.registration_number |
String | No | |
company.registration_date |
No | ||
company.vat_id |
String | No | |
company.ownership_declaration |
Object | No | |
company.ownership_declaration.user_agent |
String | No | |
company.ownership_declaration.ip |
String | No | |
company.ownership_declaration.date |
Integer | No | |
company.name |
String | No | |
company.address_kanji |
Object | No | |
company.address_kanji.line2 |
String | No | |
company.address_kanji.line1 |
String | No | |
company.address_kanji.town |
String | No | |
company.address_kanji.postal_code |
String | No | |
company.address_kanji.country |
String | No | |
company.address_kanji.state |
String | No | |
company.address_kanji.city |
String | No | |
company.address_kana |
Object | No | |
company.address_kana.line2 |
String | No | |
company.address_kana.line1 |
String | No | |
company.address_kana.town |
String | No | |
company.address_kana.postal_code |
String | No | |
company.address_kana.country |
String | No | |
company.address_kana.state |
String | No | |
company.address_kana.city |
String | No | |
company.name_kana |
String | No | |
company.structure |
String | No |
Possible values:
|
company.verification |
Object | No | |
company.verification.document |
Object | No | |
company.verification.document.back |
String | No | |
company.verification.document.front |
String | No | |
company.name_kanji |
String | No | |
company.phone |
String | No | |
company.directorship_declaration |
Object | No | |
company.directorship_declaration.user_agent |
String | No | |
company.directorship_declaration.ip |
String | No | |
company.directorship_declaration.date |
Integer | No | |
company.executives_provided |
Boolean | No | |
company.export_purpose_code |
String | No | |
company.tax_id_registrar |
String | No | |
company.address |
Object | No | |
company.address.line2 |
String | No | |
company.address.line1 |
String | No | |
company.address.postal_code |
String | No | |
company.address.country |
String | No | |
company.address.state |
String | No | |
company.address.city |
String | No | |
default_currency |
String | No |
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. |
business_profile |
Object | No |
Business information about the account. |
business_profile.annual_revenue |
Object | No | |
business_profile.annual_revenue.amount |
Integer | Yes | |
business_profile.annual_revenue.fiscal_year_end |
String | Yes | |
business_profile.annual_revenue.currency |
String | Yes | |
business_profile.product_description |
String | No | |
business_profile.mcc |
String | No | |
business_profile.name |
String | No | |
business_profile.estimated_worker_count |
Integer | No | |
business_profile.minority_owned_business_designation[] |
Array | No | |
business_profile.url |
String | No | |
business_profile.support_url |
No | ||
business_profile.support_address |
Object | No | |
business_profile.support_address.line2 |
String | No | |
business_profile.support_address.line1 |
String | No | |
business_profile.support_address.postal_code |
String | No | |
business_profile.support_address.country |
String | No | |
business_profile.support_address.state |
String | No | |
business_profile.support_address.city |
String | No | |
business_profile.monthly_estimated_revenue |
Object | No | |
business_profile.monthly_estimated_revenue.amount |
Integer | Yes | |
business_profile.monthly_estimated_revenue.currency |
String | Yes | |
business_profile.support_phone |
String | No | |
business_profile.support_email |
String | No | |
settings |
Object | No |
Options for customizing how the account functions within Stripe. |
settings.card_payments |
Object | No | |
settings.card_payments.decline_on |
Object | No | |
settings.card_payments.decline_on.avs_failure |
Boolean | No | |
settings.card_payments.decline_on.cvc_failure |
Boolean | No | |
settings.card_payments.statement_descriptor_prefix |
String | No | |
settings.card_payments.statement_descriptor_prefix_kanji |
No | ||
settings.card_payments.statement_descriptor_prefix_kana |
No | ||
settings.bacs_debit_payments |
Object | No | |
settings.bacs_debit_payments.display_name |
String | No | |
settings.payments |
Object | No | |
settings.payments.statement_descriptor_kana |
String | No | |
settings.payments.statement_descriptor_kanji |
String | No | |
settings.payments.statement_descriptor |
String | No | |
settings.invoices |
Object | No | |
settings.invoices.default_account_tax_ids |
No | ||
settings.invoices.hosted_payment_method_save |
String | No |
Possible values:
|
settings.branding |
Object | No | |
settings.branding.primary_color |
String | No | |
settings.branding.logo |
String | No | |
settings.branding.icon |
String | No | |
settings.branding.secondary_color |
String | No | |
settings.card_issuing |
Object | No | |
settings.card_issuing.tos_acceptance |
Object | No | |
settings.card_issuing.tos_acceptance.user_agent |
No | ||
settings.card_issuing.tos_acceptance.ip |
String | No | |
settings.card_issuing.tos_acceptance.date |
Integer | No | |
settings.treasury |
Object | No | |
settings.treasury.tos_acceptance |
Object | No | |
settings.treasury.tos_acceptance.user_agent |
No | ||
settings.treasury.tos_acceptance.ip |
String | No | |
settings.treasury.tos_acceptance.date |
Integer | No | |
settings.payouts |
Object | No | |
settings.payouts.schedule |
Object | No | |
settings.payouts.schedule.monthly_payout_days[] |
Array | No | |
settings.payouts.schedule.weekly_anchor |
String | No |
Possible values:
|
settings.payouts.schedule.weekly_payout_days[] |
Array | No | |
settings.payouts.schedule.interval |
String | No |
Possible values:
|
settings.payouts.schedule.monthly_anchor |
Integer | No | |
settings.payouts.schedule.delay_days |
No | ||
settings.payouts.statement_descriptor |
String | No | |
settings.payouts.debit_negative_balances |
Boolean | No | |
capabilities |
Object | No |
Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive. Required when account.controller.stripe_dashboard.type
is |
capabilities.affirm_payments |
Object | No | |
capabilities.affirm_payments.requested |
Boolean | No | |
capabilities.pix_payments |
Object | No | |
capabilities.pix_payments.requested |
Boolean | No | |
capabilities.us_bank_transfer_payments |
Object | No | |
capabilities.us_bank_transfer_payments.requested |
Boolean | No | |
capabilities.cashapp_payments |
Object | No | |
capabilities.cashapp_payments.requested |
Boolean | No | |
capabilities.acss_debit_payments |
Object | No | |
capabilities.acss_debit_payments.requested |
Boolean | No | |
capabilities.naver_pay_payments |
Object | No | |
capabilities.naver_pay_payments.requested |
Boolean | No | |
capabilities.card_issuing |
Object | No | |
capabilities.card_issuing.requested |
Boolean | No | |
capabilities.au_becs_debit_payments |
Object | No | |
capabilities.au_becs_debit_payments.requested |
Boolean | No | |
capabilities.oxxo_payments |
Object | No | |
capabilities.oxxo_payments.requested |
Boolean | No | |
capabilities.p24_payments |
Object | No | |
capabilities.p24_payments.requested |
Boolean | No | |
capabilities.jp_bank_transfer_payments |
Object | No | |
capabilities.jp_bank_transfer_payments.requested |
Boolean | No | |
capabilities.afterpay_clearpay_payments |
Object | No | |
capabilities.afterpay_clearpay_payments.requested |
Boolean | No | |
capabilities.konbini_payments |
Object | No | |
capabilities.konbini_payments.requested |
Boolean | No | |
capabilities.tax_reporting_us_1099_misc |
Object | No | |
capabilities.tax_reporting_us_1099_misc.requested |
Boolean | No | |
capabilities.samsung_pay_payments |
Object | No | |
capabilities.samsung_pay_payments.requested |
Boolean | No | |
capabilities.india_international_payments |
Object | No | |
capabilities.india_international_payments.requested |
Boolean | No | |
capabilities.card_payments |
Object | No | |
capabilities.card_payments.requested |
Boolean | No | |
capabilities.eps_payments |
Object | No | |
capabilities.eps_payments.requested |
Boolean | No | |
capabilities.us_bank_account_ach_payments |
Object | No | |
capabilities.us_bank_account_ach_payments.requested |
Boolean | No | |
capabilities.gb_bank_transfer_payments |
Object | No | |
capabilities.gb_bank_transfer_payments.requested |
Boolean | No | |
capabilities.link_payments |
Object | No | |
capabilities.link_payments.requested |
Boolean | No | |
capabilities.cartes_bancaires_payments |
Object | No | |
capabilities.cartes_bancaires_payments.requested |
Boolean | No | |
capabilities.jcb_payments |
Object | No | |
capabilities.jcb_payments.requested |
Boolean | No | |
capabilities.nz_bank_account_becs_debit_payments |
Object | No | |
capabilities.nz_bank_account_becs_debit_payments.requested |
Boolean | No | |
capabilities.amazon_pay_payments |
Object | No | |
capabilities.amazon_pay_payments.requested |
Boolean | No | |
capabilities.bacs_debit_payments |
Object | No | |
capabilities.bacs_debit_payments.requested |
Boolean | No | |
capabilities.mobilepay_payments |
Object | No | |
capabilities.mobilepay_payments.requested |
Boolean | No | |
capabilities.mx_bank_transfer_payments |
Object | No | |
capabilities.mx_bank_transfer_payments.requested |
Boolean | No | |
capabilities.billie_payments |
Object | No | |
capabilities.billie_payments.requested |
Boolean | No | |
capabilities.revolut_pay_payments |
Object | No | |
capabilities.revolut_pay_payments.requested |
Boolean | No | |
capabilities.sepa_bank_transfer_payments |
Object | No | |
capabilities.sepa_bank_transfer_payments.requested |
Boolean | No | |
capabilities.fpx_payments |
Object | No | |
capabilities.fpx_payments.requested |
Boolean | No | |
capabilities.sepa_debit_payments |
Object | No | |
capabilities.sepa_debit_payments.requested |
Boolean | No | |
capabilities.promptpay_payments |
Object | No | |
capabilities.promptpay_payments.requested |
Boolean | No | |
capabilities.treasury |
Object | No | |
capabilities.treasury.requested |
Boolean | No | |
capabilities.giropay_payments |
Object | No | |
capabilities.giropay_payments.requested |
Boolean | No | |
capabilities.payco_payments |
Object | No | |
capabilities.payco_payments.requested |
Boolean | No | |
capabilities.satispay_payments |
Object | No | |
capabilities.satispay_payments.requested |
Boolean | No | |
capabilities.kr_card_payments |
Object | No | |
capabilities.kr_card_payments.requested |
Boolean | No | |
capabilities.legacy_payments |
Object | No | |
capabilities.legacy_payments.requested |
Boolean | No | |
capabilities.tax_reporting_us_1099_k |
Object | No | |
capabilities.tax_reporting_us_1099_k.requested |
Boolean | No | |
capabilities.grabpay_payments |
Object | No | |
capabilities.grabpay_payments.requested |
Boolean | No | |
capabilities.sofort_payments |
Object | No | |
capabilities.sofort_payments.requested |
Boolean | No | |
capabilities.swish_payments |
Object | No | |
capabilities.swish_payments.requested |
Boolean | No | |
capabilities.ideal_payments |
Object | No | |
capabilities.ideal_payments.requested |
Boolean | No | |
capabilities.transfers |
Object | No | |
capabilities.transfers.requested |
Boolean | No | |
capabilities.pay_by_bank_payments |
Object | No | |
capabilities.pay_by_bank_payments.requested |
Boolean | No | |
capabilities.zip_payments |
Object | No | |
capabilities.zip_payments.requested |
Boolean | No | |
capabilities.twint_payments |
Object | No | |
capabilities.twint_payments.requested |
Boolean | No | |
capabilities.crypto_payments |
Object | No | |
capabilities.crypto_payments.requested |
Boolean | No | |
capabilities.multibanco_payments |
Object | No | |
capabilities.multibanco_payments.requested |
Boolean | No | |
capabilities.boleto_payments |
Object | No | |
capabilities.boleto_payments.requested |
Boolean | No | |
capabilities.klarna_payments |
Object | No | |
capabilities.klarna_payments.requested |
Boolean | No | |
capabilities.kakao_pay_payments |
Object | No | |
capabilities.kakao_pay_payments.requested |
Boolean | No | |
capabilities.paynow_payments |
Object | No | |
capabilities.paynow_payments.requested |
Boolean | No | |
capabilities.alma_payments |
Object | No | |
capabilities.alma_payments.requested |
Boolean | No | |
capabilities.bank_transfer_payments |
Object | No | |
capabilities.bank_transfer_payments.requested |
Boolean | No | |
capabilities.bancontact_payments |
Object | No | |
capabilities.bancontact_payments.requested |
Boolean | No | |
capabilities.blik_payments |
Object | No | |
capabilities.blik_payments.requested |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.