openapi-directory/api/stripe.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.stripe.com/"}],"info":{"contact":{"email":"dev-platform@stripe.com","name":"Stripe Dev Platform Team","url":"https://stripe.com","x-twitter":"stripe"},"description":"The Stripe REST API. Please see https://stripe.com/docs/api for more details.","termsOfService":"https://stripe.com/us/terms/","title":"Stripe API","version":"Tue Apr 15 2025 13:53:23 GMT+0000 (Coordinated Universal Time)","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/stripe/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.yaml","version":"3.0"}],"x-providerName":"stripe.com","x-stripeSpecFilename":"spec3"},"security":[{"basicAuth":[]},{"bearerAuth":[]}],"paths":{"/v1/account":{"get":{"description":"<p>Retrieves the details of an account.</p>","operationId":"GetAccount","parameters":[{"description":"Specifies which fields in the response should be expanded.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"maxLength":5000,"type":"string"},"type":"array"},"style":"deepObject"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}}},"/v1/account_links":{"post":{"description":"<p>Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.</p>","operationId":"PostAccountLinks","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{"expand":{"explode":true,"style":"deepObject"}},"schema":{"additionalProperties":false,"properties":{"account":{"description":"The identifier of the account to create an account link for.","maxLength":5000,"type":"string"},"collect":{"description":"Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.","enum":["currently_due","eventually_due"],"type":"string"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"refresh_url":{"description":"The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user.","type":"string"},"return_url":{"description":"The URL that the user will be redirected to upon leaving or completing the linked flow.","type":"string"},"type":{"description":"The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.","enum":["account_onboarding","account_update"],"type":"string","x-stripeBypassValidation":true}},"required":["account","type"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_link"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}}},"/v1/accounts":{"get":{"description":"<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>","operationId":"GetAccounts","parameters":[{"explode":true,"in":"query","name":"created","required":false,"schema":{"anyOf":[{"properties":{"gt":{"type":"integer"},"gte":{"type":"integer"},"lt":{"type":"integer"},"lte":{"type":"integer"}},"title":"range_query_specs","type":"object"},{"type":"integer"}]},"style":"deepObject"},{"description":"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.","in":"query","name":"ending_before","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Specifies which fields in the response should be expanded.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"maxLength":5000,"type":"string"},"type":"array"},"style":"deepObject"},{"description":"A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","in":"query","name":"limit","required":false,"schema":{"type":"integer"},"style":"form"},{"description":"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.","in":"query","name":"starting_after","required":false,"schema":{"type":"string"},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"data":{"items":{"$ref":"#/components/schemas/account"},"type":"array"},"has_more":{"description":"True if this list has another page of items after this one that can be fetched.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value. Always has the value `list`.","enum":["list"],"type":"string"},"url":{"description":"The URL where this list can be accessed.","maxLength":5000,"pattern":"^/v1/accounts","type":"string"}},"required":["data","has_more","object","url"],"title":"AccountList","type":"object","x-expandableFields":["data"]}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}},"post":{"description":"<p>With <a href=\"/docs/connect\">Connect</a>, you can create Stripe accounts for your users.\nTo do this, you’ll first need to <a href=\"https://dashboard.stripe.com/account/applications/settings\">register your platform</a>.</p>\n\n<p>If you’ve already collected information for your connected accounts, you <a href=\"/docs/connect/best-practices#onboarding\">can pre-fill that information</a> when\ncreating the account. Connect Onboarding won’t ask for the pre-filled information during account onboarding.\nYou can pre-fill any information on the account.</p>","operationId":"PostAccounts","requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{"bank_account":{"explode":true,"style":"deepObject"},"business_profile":{"explode":true,"style":"deepObject"},"capabilities":{"explode":true,"style":"deepObject"},"company":{"explode":true,"style":"deepObject"},"documents":{"explode":true,"style":"deepObject"},"expand":{"explode":true,"style":"deepObject"},"individual":{"explode":true,"style":"deepObject"},"metadata":{"explode":true,"style":"deepObject"},"settings":{"explode":true,"style":"deepObject"},"tos_acceptance":{"explode":true,"style":"deepObject"}},"schema":{"additionalProperties":false,"properties":{"account_token":{"description":"An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.","maxLength":5000,"type":"string"},"bank_account":{"anyOf":[{"properties":{"account_holder_name":{"maxLength":5000,"type":"string"},"account_holder_type":{"enum":["company","individual"],"maxLength":5000,"type":"string"},"account_number":{"maxLength":5000,"type":"string"},"account_type":{"enum":["checking","futsu","savings","toza"],"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"currency":{"type":"string"},"documents":{"properties":{"bank_account_ownership_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"}},"title":"external_account_documents_param","type":"object"},"object":{"enum":["bank_account"],"maxLength":5000,"type":"string"},"routing_number":{"maxLength":5000,"type":"string"}},"required":["account_number","country"],"title":"external_account_payout_bank_account","type":"object"},{"maxLength":5000,"type":"string"}],"description":"Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details."},"business_profile":{"description":"Business information about the account.","properties":{"mcc":{"maxLength":4,"type":"string"},"name":{"maxLength":5000,"type":"string"},"product_description":{"maxLength":40000,"type":"string"},"support_address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"support_email":{"type":"string"},"support_phone":{"maxLength":5000,"type":"string"},"support_url":{"anyOf":[{"type":"string"},{"enum":[""],"type":"string"}]},"url":{"maxLength":5000,"type":"string"}},"title":"business_profile_specs","type":"object"},"business_type":{"description":"The business type.","enum":["company","government_entity","individual","non_profit"],"type":"string","x-stripeBypassValidation":true},"capabilities":{"description":"Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.","properties":{"acss_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"affirm_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"afterpay_clearpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"au_becs_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bacs_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bancontact_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bank_transfer_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"blik_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"boleto_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"card_issuing":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"card_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"cartes_bancaires_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"cashapp_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"eps_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"fpx_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"giropay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"grabpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"ideal_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"india_international_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"jcb_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"klarna_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"konbini_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"legacy_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"link_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"oxxo_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"p24_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"paynow_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"promptpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"sepa_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"sofort_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"tax_reporting_us_1099_k":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"tax_reporting_us_1099_misc":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"transfers":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"treasury":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"us_bank_account_ach_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"}},"title":"capabilities_param","type":"object"},"company":{"description":"Information about the company or business. This field is available for any `business_type`.","properties":{"address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"address_kana":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kana_specs","type":"object"},"address_kanji":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kanji_specs","type":"object"},"directors_provided":{"type":"boolean"},"executives_provided":{"type":"boolean"},"export_license_id":{"maxLength":5000,"type":"string"},"export_purpose_code":{"maxLength":5000,"type":"string"},"name":{"maxLength":100,"type":"string"},"name_kana":{"maxLength":100,"type":"string"},"name_kanji":{"maxLength":100,"type":"string"},"owners_provided":{"type":"boolean"},"ownership_declaration":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"company_ownership_declaration","type":"object"},"phone":{"maxLength":5000,"type":"string"},"registration_number":{"maxLength":5000,"type":"string"},"structure":{"enum":["","free_zone_establishment","free_zone_llc","government_instrumentality","governmental_unit","incorporated_non_profit","limited_liability_partnership","llc","multi_member_llc","private_company","private_corporation","private_partnership","public_company","public_corporation","public_partnership","single_member_llc","sole_establishment","sole_proprietorship","tax_exempt_government_instrumentality","unincorporated_association","unincorporated_non_profit"],"type":"string","x-stripeBypassValidation":true},"tax_id":{"maxLength":5000,"type":"string"},"tax_id_registrar":{"maxLength":5000,"type":"string"},"vat_id":{"maxLength":5000,"type":"string"},"verification":{"properties":{"document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"verification_document_specs","type":"object"}},"title":"verification_specs","type":"object"}},"title":"company_specs","type":"object"},"country":{"description":"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.","maxLength":5000,"type":"string"},"default_currency":{"description":"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://stripe.com/docs/payouts).","type":"string"},"documents":{"description":"Documents that may be submitted to satisfy various informational requests.","properties":{"bank_account_ownership_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_license":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_memorandum_of_association":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_ministerial_decree":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_registration_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_tax_id_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"proof_of_registration":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"}},"title":"documents_specs","type":"object"},"email":{"description":"The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.","type":"string"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"external_account":{"description":"A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/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](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>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](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.","maxLength":5000,"type":"string","x-stripeBypassValidation":true},"individual":{"description":"Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.","properties":{"address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"address_kana":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kana_specs","type":"object"},"address_kanji":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kanji_specs","type":"object"},"dob":{"anyOf":[{"properties":{"day":{"type":"integer"},"month":{"type":"integer"},"year":{"type":"integer"}},"required":["day","month","year"],"title":"date_of_birth_specs","type":"object"},{"enum":[""],"type":"string"}]},"email":{"type":"string"},"first_name":{"maxLength":100,"type":"string"},"first_name_kana":{"maxLength":5000,"type":"string"},"first_name_kanji":{"maxLength":5000,"type":"string"},"full_name_aliases":{"anyOf":[{"items":{"maxLength":300,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}]},"gender":{"type":"string"},"id_number":{"maxLength":5000,"type":"string"},"id_number_secondary":{"maxLength":5000,"type":"string"},"last_name":{"maxLength":100,"type":"string"},"last_name_kana":{"maxLength":5000,"type":"string"},"last_name_kanji":{"maxLength":5000,"type":"string"},"maiden_name":{"maxLength":5000,"type":"string"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}]},"phone":{"type":"string"},"political_exposure":{"enum":["existing","none"],"type":"string"},"registered_address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"ssn_last_4":{"maxLength":5000,"type":"string"},"verification":{"properties":{"additional_document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"person_verification_document_specs","type":"object"},"document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"person_verification_document_specs","type":"object"}},"title":"person_verification_specs","type":"object"}},"title":"individual_specs","type":"object"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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 `metadata`."},"settings":{"description":"Options for customizing how the account functions within Stripe.","properties":{"branding":{"properties":{"icon":{"maxLength":5000,"type":"string"},"logo":{"maxLength":5000,"type":"string"},"primary_color":{"maxLength":5000,"type":"string"},"secondary_color":{"maxLength":5000,"type":"string"}},"title":"branding_settings_specs","type":"object"},"card_issuing":{"properties":{"tos_acceptance":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"settings_terms_of_service_specs","type":"object"}},"title":"card_issuing_settings_specs","type":"object"},"card_payments":{"properties":{"decline_on":{"properties":{"avs_failure":{"type":"boolean"},"cvc_failure":{"type":"boolean"}},"title":"decline_charge_on_specs","type":"object"},"statement_descriptor_prefix":{"maxLength":10,"type":"string"},"statement_descriptor_prefix_kana":{"anyOf":[{"maxLength":10,"type":"string"},{"enum":[""],"type":"string"}]},"statement_descriptor_prefix_kanji":{"anyOf":[{"maxLength":10,"type":"string"},{"enum":[""],"type":"string"}]}},"title":"card_payments_settings_specs","type":"object"},"payments":{"properties":{"statement_descriptor":{"maxLength":22,"type":"string"},"statement_descriptor_kana":{"maxLength":22,"type":"string"},"statement_descriptor_kanji":{"maxLength":22,"type":"string"}},"title":"payments_settings_specs","type":"object"},"payouts":{"properties":{"debit_negative_balances":{"type":"boolean"},"schedule":{"properties":{"delay_days":{"anyOf":[{"enum":["minimum"],"maxLength":5000,"type":"string"},{"type":"integer"}]},"interval":{"enum":["daily","manual","monthly","weekly"],"maxLength":5000,"type":"string","x-stripeBypassValidation":true},"monthly_anchor":{"type":"integer"},"weekly_anchor":{"enum":["friday","monday","saturday","sunday","thursday","tuesday","wednesday"],"maxLength":5000,"type":"string"}},"title":"transfer_schedule_specs","type":"object"},"statement_descriptor":{"maxLength":22,"type":"string"}},"title":"payout_settings_specs","type":"object"},"treasury":{"properties":{"tos_acceptance":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"settings_terms_of_service_specs","type":"object"}},"title":"treasury_settings_specs","type":"object"}},"title":"settings_specs","type":"object"},"tos_acceptance":{"description":"Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).","properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"service_agreement":{"maxLength":5000,"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"tos_acceptance_specs","type":"object"},"type":{"description":"The type of Stripe account to create. May be one of `custom`, `express` or `standard`.","enum":["custom","express","standard"],"type":"string"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}}},"/v1/accounts/{account}":{"delete":{"description":"<p>With <a href=\"/docs/connect\">Connect</a>, you can delete accounts you manage.</p>\n\n<p>Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.</p>\n\n<p>If you want to delete your own account, use the <a href=\"https://dashboard.stripe.com/account\">account information tab in your account settings</a> instead.</p>","operationId":"DeleteAccountsAccount","parameters":[{"in":"path","name":"account","required":true,"schema":{"maxLength":5000,"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_account"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}},"get":{"description":"<p>Retrieves the details of an account.</p>","operationId":"GetAccountsAccount","parameters":[{"in":"path","name":"account","required":true,"schema":{"maxLength":5000,"type":"string"},"style":"simple"},{"description":"Specifies which fields in the response should be expanded.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"maxLength":5000,"type":"string"},"type":"array"},"style":"deepObject"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}},"post":{"description":"<p>Updates a <a href=\"/docs/connect/accounts\">connected account</a> by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.</p>\n\n<p>For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an <a href=\"/docs/api/account_links\">Account Link</a>\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as <strong>Custom Only</strong> or <strong>Custom and Express</strong>\nbelow.</p>\n\n<p>To update your own account, use the <a href=\"https://dashboard.stripe.com/account\">Dashboard</a>. Refer to our\n<a href=\"/docs/connect/updating-accounts\">Connect</a> documentation to learn more about updating accounts.</p>","operationId":"PostAccountsAccount","parameters":[{"in":"path","name":"account","required":true,"schema":{"maxLength":5000,"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{"business_profile":{"explode":true,"style":"deepObject"},"capabilities":{"explode":true,"style":"deepObject"},"company":{"explode":true,"style":"deepObject"},"documents":{"explode":true,"style":"deepObject"},"expand":{"explode":true,"style":"deepObject"},"individual":{"explode":true,"style":"deepObject"},"metadata":{"explode":true,"style":"deepObject"},"settings":{"explode":true,"style":"deepObject"},"tos_acceptance":{"explode":true,"style":"deepObject"}},"schema":{"additionalProperties":false,"properties":{"account_token":{"description":"An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.","maxLength":5000,"type":"string"},"business_profile":{"description":"Business information about the account.","properties":{"mcc":{"maxLength":4,"type":"string"},"name":{"maxLength":5000,"type":"string"},"product_description":{"maxLength":40000,"type":"string"},"support_address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"support_email":{"type":"string"},"support_phone":{"maxLength":5000,"type":"string"},"support_url":{"anyOf":[{"type":"string"},{"enum":[""],"type":"string"}]},"url":{"maxLength":5000,"type":"string"}},"title":"business_profile_specs","type":"object"},"business_type":{"description":"The business type.","enum":["company","government_entity","individual","non_profit"],"type":"string","x-stripeBypassValidation":true},"capabilities":{"description":"Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive.","properties":{"acss_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"affirm_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"afterpay_clearpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"au_becs_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bacs_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bancontact_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"bank_transfer_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"blik_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"boleto_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"card_issuing":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"card_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"cartes_bancaires_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"cashapp_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"eps_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"fpx_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"giropay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"grabpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"ideal_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"india_international_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"jcb_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"klarna_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"konbini_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"legacy_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"link_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"oxxo_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"p24_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"paynow_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"promptpay_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"sepa_debit_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"sofort_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"tax_reporting_us_1099_k":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"tax_reporting_us_1099_misc":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"transfers":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"treasury":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"},"us_bank_account_ach_payments":{"properties":{"requested":{"type":"boolean"}},"title":"capability_param","type":"object"}},"title":"capabilities_param","type":"object"},"company":{"description":"Information about the company or business. This field is available for any `business_type`.","properties":{"address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"address_kana":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kana_specs","type":"object"},"address_kanji":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kanji_specs","type":"object"},"directors_provided":{"type":"boolean"},"executives_provided":{"type":"boolean"},"export_license_id":{"maxLength":5000,"type":"string"},"export_purpose_code":{"maxLength":5000,"type":"string"},"name":{"maxLength":100,"type":"string"},"name_kana":{"maxLength":100,"type":"string"},"name_kanji":{"maxLength":100,"type":"string"},"owners_provided":{"type":"boolean"},"ownership_declaration":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"company_ownership_declaration","type":"object"},"phone":{"maxLength":5000,"type":"string"},"registration_number":{"maxLength":5000,"type":"string"},"structure":{"enum":["","free_zone_establishment","free_zone_llc","government_instrumentality","governmental_unit","incorporated_non_profit","limited_liability_partnership","llc","multi_member_llc","private_company","private_corporation","private_partnership","public_company","public_corporation","public_partnership","single_member_llc","sole_establishment","sole_proprietorship","tax_exempt_government_instrumentality","unincorporated_association","unincorporated_non_profit"],"type":"string","x-stripeBypassValidation":true},"tax_id":{"maxLength":5000,"type":"string"},"tax_id_registrar":{"maxLength":5000,"type":"string"},"vat_id":{"maxLength":5000,"type":"string"},"verification":{"properties":{"document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"verification_document_specs","type":"object"}},"title":"verification_specs","type":"object"}},"title":"company_specs","type":"object"},"default_currency":{"description":"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://stripe.com/docs/payouts).","type":"string"},"documents":{"description":"Documents that may be submitted to satisfy various informational requests.","properties":{"bank_account_ownership_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_license":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_memorandum_of_association":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_ministerial_decree":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_registration_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"company_tax_id_verification":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"},"proof_of_registration":{"properties":{"files":{"items":{"maxLength":500,"type":"string"},"type":"array"}},"title":"documents_param","type":"object"}},"title":"documents_specs","type":"object"},"email":{"description":"The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent.","type":"string"},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"external_account":{"description":"A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/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](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation. <br><br>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](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.","maxLength":5000,"type":"string","x-stripeBypassValidation":true},"individual":{"description":"Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.","properties":{"address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"address_kana":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kana_specs","type":"object"},"address_kanji":{"properties":{"city":{"maxLength":5000,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":5000,"type":"string"},"line2":{"maxLength":5000,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"},"town":{"maxLength":5000,"type":"string"}},"title":"japan_address_kanji_specs","type":"object"},"dob":{"anyOf":[{"properties":{"day":{"type":"integer"},"month":{"type":"integer"},"year":{"type":"integer"}},"required":["day","month","year"],"title":"date_of_birth_specs","type":"object"},{"enum":[""],"type":"string"}]},"email":{"type":"string"},"first_name":{"maxLength":100,"type":"string"},"first_name_kana":{"maxLength":5000,"type":"string"},"first_name_kanji":{"maxLength":5000,"type":"string"},"full_name_aliases":{"anyOf":[{"items":{"maxLength":300,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}]},"gender":{"type":"string"},"id_number":{"maxLength":5000,"type":"string"},"id_number_secondary":{"maxLength":5000,"type":"string"},"last_name":{"maxLength":100,"type":"string"},"last_name_kana":{"maxLength":5000,"type":"string"},"last_name_kanji":{"maxLength":5000,"type":"string"},"maiden_name":{"maxLength":5000,"type":"string"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}]},"phone":{"type":"string"},"political_exposure":{"enum":["existing","none"],"type":"string"},"registered_address":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"maxLength":5000,"type":"string"},"line1":{"maxLength":200,"type":"string"},"line2":{"maxLength":200,"type":"string"},"postal_code":{"maxLength":5000,"type":"string"},"state":{"maxLength":5000,"type":"string"}},"title":"address_specs","type":"object"},"ssn_last_4":{"maxLength":5000,"type":"string"},"verification":{"properties":{"additional_document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"person_verification_document_specs","type":"object"},"document":{"properties":{"back":{"maxLength":500,"type":"string"},"front":{"maxLength":500,"type":"string"}},"title":"person_verification_document_specs","type":"object"}},"title":"person_verification_specs","type":"object"}},"title":"individual_specs","type":"object"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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 `metadata`."},"settings":{"description":"Options for customizing how the account functions within Stripe.","properties":{"branding":{"properties":{"icon":{"maxLength":5000,"type":"string"},"logo":{"maxLength":5000,"type":"string"},"primary_color":{"maxLength":5000,"type":"string"},"secondary_color":{"maxLength":5000,"type":"string"}},"title":"branding_settings_specs","type":"object"},"card_issuing":{"properties":{"tos_acceptance":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"settings_terms_of_service_specs","type":"object"}},"title":"card_issuing_settings_specs","type":"object"},"card_payments":{"properties":{"decline_on":{"properties":{"avs_failure":{"type":"boolean"},"cvc_failure":{"type":"boolean"}},"title":"decline_charge_on_specs","type":"object"},"statement_descriptor_prefix":{"maxLength":10,"type":"string"},"statement_descriptor_prefix_kana":{"anyOf":[{"maxLength":10,"type":"string"},{"enum":[""],"type":"string"}]},"statement_descriptor_prefix_kanji":{"anyOf":[{"maxLength":10,"type":"string"},{"enum":[""],"type":"string"}]}},"title":"card_payments_settings_specs","type":"object"},"payments":{"properties":{"statement_descriptor":{"maxLength":22,"type":"string"},"statement_descriptor_kana":{"maxLength":22,"type":"string"},"statement_descriptor_kanji":{"maxLength":22,"type":"string"}},"title":"payments_settings_specs","type":"object"},"payouts":{"properties":{"debit_negative_balances":{"type":"boolean"},"schedule":{"properties":{"delay_days":{"anyOf":[{"enum":["minimum"],"maxLength":5000,"type":"string"},{"type":"integer"}]},"interval":{"enum":["daily","manual","monthly","weekly"],"maxLength":5000,"type":"string","x-stripeBypassValidation":true},"monthly_anchor":{"type":"integer"},"weekly_anchor":{"enum":["friday","monday","saturday","sunday","thursday","tuesday","wednesday"],"maxLength":5000,"type":"string"}},"title":"transfer_schedule_specs","type":"object"},"statement_descriptor":{"maxLength":22,"type":"string"}},"title":"payout_settings_specs","type":"object"},"treasury":{"properties":{"tos_acceptance":{"properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"settings_terms_of_service_specs","type":"object"}},"title":"treasury_settings_specs","type":"object"}},"title":"settings_specs_update","type":"object"},"tos_acceptance":{"description":"Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).","properties":{"date":{"format":"unix-time","type":"integer"},"ip":{"type":"string"},"service_agreement":{"maxLength":5000,"type":"string"},"user_agent":{"maxLength":5000,"type":"string"}},"title":"tos_acceptance_specs","type":"object"}},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account"}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}},"description":"Error response."}}}},"/v1/accounts/{account}/bank_accounts":{"post":{"description":"<p>Create an external account for a given account.</p>","operationId":"PostAccountsAccountBankAccounts","parameters":[{"in":"path","name":"account","required":true,"schema":{"maxLength":5000,"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{"bank_account":{"explode":true,"style":"deepObject"},"expand":{"explode":true,"style":"deepObject"},"metadata":{"explode":true,"style":"deepObject"}},"schema":{"additionalProperties":false,"properties":{"bank_account":{"anyOf":[{"properties":{"account_holder_name":{"maxLength":5000,"type":"string"},"account_holder_type":{"enum":["company","individual"],"maxLength":5000,"type":"string"},"account_number":{"maxLength":5000,"type":"string"},"account_type":{"enum":["checking","futsu","savin