View Source Stripe.Account (Striped v0.2.0)

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current e-mail address or if the account is enabled yet to make live charges.

Some properties, marked below, are available only to platforms that want to create and manage Express or Custom accounts.

Link to this section Summary

Types

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.

The individual's verification document information.

Information about the person represented by the account. This field is null unless business_type is set to individual.

Information about the company or business. This field is available for any business_type.

Information about the company or business. This field is available for any business_type.

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.

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.

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.

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.

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.

Documents that may be submitted to satisfy various informational requests.

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.

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.

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.

Options for customizing how the account functions within Stripe.

Business information about the account.

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.

Options for customizing how the account functions within Stripe.

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.

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.

Information about the company or business. This field is available for any business_type.

Documents that may be submitted to satisfy various informational requests.

Documents that may be submitted to satisfy various informational requests.

Documents that may be submitted to satisfy various informational requests.

Documents that may be submitted to satisfy various informational requests.

Documents that may be submitted to satisfy various informational requests.

Settings specific to card charging on the account.

The individual's verification document information.

Documents that may be submitted to satisfy various informational requests.

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.

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.

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.

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.

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.

Information about the person represented by the account. This field is null unless business_type is set to individual.

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.

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.

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.

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.

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.

Information about the company or business. This field is available for any business_type.

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.

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.

Options for customizing how the account functions within Stripe.

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.

Options for customizing how the account functions within Stripe.

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.

Documents that may be submitted to satisfy various informational requests.

Information about the person represented by the account. This field is null unless business_type is set to individual.

Settings specific to the account's payouts.

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.

Options for customizing how the account functions within Stripe.

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.

Business information about the account.

t()

The account type.

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.

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.

Settings specific to the account's Treasury FinancialAccounts.

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.

Options for customizing how the account functions within Stripe.

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.

Information about the person represented by the account. This field is null unless business_type is set to individual.

Functions

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

With Connect, you can create Stripe accounts for your users.To do this, you’ll first need to register your platform.

With Connect, you can delete accounts you manage.

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

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.

With Connect, you may flag accounts as suspicious.

Retrieves the details of an account.

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

Link to this section Types

@type acss_debit_payments() :: %{optional(:requested) => :boolean}

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.

@type additional_document() :: %{
  optional(:back) => :string,
  optional(:front) => :string
}

The individual's verification document information.

@type address() :: %{
  optional(:city) => :string,
  optional(:country) => :string,
  optional(:line1) => :string,
  optional(:line2) => :string,
  optional(:postal_code) => :string,
  optional(:state) => :string
}

Information about the person represented by the account. This field is null unless business_type is set to individual.

@type address_kana() :: %{
  optional(:city) => :string,
  optional(:country) => :string,
  optional(:line1) => :string,
  optional(:line2) => :string,
  optional(:postal_code) => :string,
  optional(:state) => :string,
  optional(:town) => :string
}

Information about the company or business. This field is available for any business_type.

@type address_kanji() :: %{
  optional(:city) => :string,
  optional(:country) => :string,
  optional(:line1) => :string,
  optional(:line2) => :string,
  optional(:postal_code) => :string,
  optional(:state) => :string,
  optional(:town) => :string
}

Information about the company or business. This field is available for any business_type.

@type affirm_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

afterpay_clearpay_payments()

View Source
@type afterpay_clearpay_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

au_becs_debit_payments()

View Source
@type au_becs_debit_payments() :: %{optional(:requested) => :boolean}

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.

@type bacs_debit_payments() :: %{optional(:requested) => :boolean}

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.

@type bancontact_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

bank_account_ownership_verification()

View Source
@type bank_account_ownership_verification() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

Link to this type

bank_transfer_payments()

View Source
@type bank_transfer_payments() :: %{optional(:requested) => :boolean}

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.

@type blik_payments() :: %{optional(:requested) => :boolean}

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.

@type boleto_payments() :: %{optional(:requested) => :boolean}

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.

@type branding() :: %{
  optional(:icon) => :string,
  optional(:logo) => :string,
  optional(:primary_color) => :string,
  optional(:secondary_color) => :string
}

Options for customizing how the account functions within Stripe.

@type business_profile() :: %{
  optional(:mcc) => :string,
  optional(:name) => :string,
  optional(:product_description) => :string,
  :support_address => support_address(),
  optional(:support_email) => :string,
  optional(:support_phone) => :string,
  optional(:support_url) => :string | :string,
  optional(:url) => :string
}

Business information about the account.

@type capabilities() :: %{
  link_payments: link_payments(),
  card_issuing: card_issuing(),
  treasury: treasury(),
  oxxo_payments: oxxo_payments(),
  affirm_payments: affirm_payments(),
  promptpay_payments: promptpay_payments(),
  bank_transfer_payments: bank_transfer_payments(),
  sofort_payments: sofort_payments(),
  acss_debit_payments: acss_debit_payments(),
  cartes_bancaires_payments: cartes_bancaires_payments(),
  bacs_debit_payments: bacs_debit_payments(),
  tax_reporting_us_1099_misc: tax_reporting_us_1099_misc(),
  paynow_payments: paynow_payments(),
  klarna_payments: klarna_payments(),
  us_bank_account_ach_payments: us_bank_account_ach_payments(),
  card_payments: card_payments(),
  p24_payments: p24_payments(),
  boleto_payments: boleto_payments(),
  fpx_payments: fpx_payments(),
  au_becs_debit_payments: au_becs_debit_payments(),
  konbini_payments: konbini_payments(),
  ideal_payments: ideal_payments(),
  afterpay_clearpay_payments: afterpay_clearpay_payments(),
  blik_payments: blik_payments(),
  bancontact_payments: bancontact_payments(),
  giropay_payments: giropay_payments(),
  legacy_payments: legacy_payments(),
  sepa_debit_payments: sepa_debit_payments(),
  transfers: transfers(),
  eps_payments: eps_payments(),
  grabpay_payments: grabpay_payments(),
  tax_reporting_us_1099_k: tax_reporting_us_1099_k(),
  jcb_payments: jcb_payments()
}

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.

@type card_issuing() :: %{tos_acceptance: tos_acceptance()}

Options for customizing how the account functions within Stripe.

@type card_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

cartes_bancaires_payments()

View Source
@type cartes_bancaires_payments() :: %{optional(:requested) => :boolean}

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.

@type company() :: %{
  :address => address(),
  :address_kana => address_kana(),
  :address_kanji => address_kanji(),
  optional(:directors_provided) => :boolean,
  optional(:executives_provided) => :boolean,
  optional(:name) => :string,
  optional(:name_kana) => :string,
  optional(:name_kanji) => :string,
  optional(:owners_provided) => :boolean,
  :ownership_declaration => ownership_declaration(),
  optional(:phone) => :string,
  optional(:registration_number) => :string,
  optional(:structure) =>
    :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,
  optional(:tax_id) => :string,
  optional(:tax_id_registrar) => :string,
  optional(:vat_id) => :string,
  verification: verification()
}

Information about the company or business. This field is available for any business_type.

@type company_license() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

Link to this type

company_memorandum_of_association()

View Source
@type company_memorandum_of_association() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

Link to this type

company_ministerial_decree()

View Source
@type company_ministerial_decree() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

Link to this type

company_registration_verification()

View Source
@type company_registration_verification() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

Link to this type

company_tax_id_verification()

View Source
@type company_tax_id_verification() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

@type decline_on() :: %{
  optional(:avs_failure) => :boolean,
  optional(:cvc_failure) => :boolean
}

Settings specific to card charging on the account.

@type document() :: %{optional(:back) => :string, optional(:front) => :string}

The individual's verification document information.

@type documents() :: %{
  bank_account_ownership_verification: bank_account_ownership_verification(),
  company_license: company_license(),
  company_memorandum_of_association: company_memorandum_of_association(),
  company_ministerial_decree: company_ministerial_decree(),
  company_registration_verification: company_registration_verification(),
  company_tax_id_verification: company_tax_id_verification(),
  proof_of_registration: proof_of_registration()
}

Documents that may be submitted to satisfy various informational requests.

@type eps_payments() :: %{optional(:requested) => :boolean}

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.

@type fpx_payments() :: %{optional(:requested) => :boolean}

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.

@type giropay_payments() :: %{optional(:requested) => :boolean}

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.

@type grabpay_payments() :: %{optional(:requested) => :boolean}

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.

@type ideal_payments() :: %{optional(:requested) => :boolean}

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.

@type individual() :: %{
  :address => address(),
  :address_kana => address_kana(),
  :address_kanji => address_kanji(),
  optional(:dob) => :object | :string,
  optional(:email) => :string,
  optional(:first_name) => :string,
  optional(:first_name_kana) => :string,
  optional(:first_name_kanji) => :string,
  optional(:full_name_aliases) => [:string] | :string,
  optional(:gender) => :string,
  optional(:id_number) => :string,
  optional(:id_number_secondary) => :string,
  optional(:last_name) => :string,
  optional(:last_name_kana) => :string,
  optional(:last_name_kanji) => :string,
  optional(:maiden_name) => :string,
  optional(:metadata) => :object | :string,
  optional(:phone) => :string,
  optional(:political_exposure) => :existing | :none,
  :registered_address => registered_address(),
  optional(:ssn_last_4) => :string,
  verification: verification()
}

Information about the person represented by the account. This field is null unless business_type is set to individual.

@type jcb_payments() :: %{optional(:requested) => :boolean}

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.

@type klarna_payments() :: %{optional(:requested) => :boolean}

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.

@type konbini_payments() :: %{optional(:requested) => :boolean}

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.

@type legacy_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

ownership_declaration()

View Source
@type ownership_declaration() :: %{
  optional(:date) => :integer,
  optional(:ip) => :string,
  optional(:user_agent) => :string
}

Information about the company or business. This field is available for any business_type.

@type oxxo_payments() :: %{optional(:requested) => :boolean}

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.

@type p24_payments() :: %{optional(:requested) => :boolean}

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.

@type payments() :: %{
  optional(:statement_descriptor) => :string,
  optional(:statement_descriptor_kana) => :string,
  optional(:statement_descriptor_kanji) => :string
}

Options for customizing how the account functions within Stripe.

@type paynow_payments() :: %{optional(:requested) => :boolean}

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.

@type payouts() :: %{
  optional(:debit_negative_balances) => :boolean,
  :schedule => schedule(),
  optional(:statement_descriptor) => :string
}

Options for customizing how the account functions within Stripe.

@type promptpay_payments() :: %{optional(:requested) => :boolean}

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.

Link to this type

proof_of_registration()

View Source
@type proof_of_registration() :: %{optional(:files) => [:string]}

Documents that may be submitted to satisfy various informational requests.

@type registered_address() :: %{
  optional(:city) => :string,
  optional(:country) => :string,
  optional(:line1) => :string,
  optional(:line2) => :string,
  optional(:postal_code) => :string,
  optional(:state) => :string
}

Information about the person represented by the account. This field is null unless business_type is set to individual.

@type relationship() :: %{
  optional(:director) => :boolean,
  optional(:executive) => :boolean,
  optional(:owner) => :boolean,
  optional(:representative) => :boolean
}
@type schedule() :: %{
  optional(:delay_days) => :minimum | :integer,
  optional(:interval) => :daily | :manual | :monthly | :weekly,
  optional(:monthly_anchor) => :integer,
  optional(:weekly_anchor) =>
    :friday | :monday | :saturday | :sunday | :thursday | :tuesday | :wednesday
}

Settings specific to the account's payouts.

@type sepa_debit_payments() :: %{optional(:requested) => :boolean}

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.

@type settings() :: %{
  branding: branding(),
  card_issuing: card_issuing(),
  card_payments: card_payments(),
  payments: payments(),
  payouts: payouts(),
  treasury: treasury()
}

Options for customizing how the account functions within Stripe.

@type sofort_payments() :: %{optional(:requested) => :boolean}

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.

@type support_address() :: %{
  optional(:city) => :string,
  optional(:country) => :string,
  optional(:line1) => :string,
  optional(:line2) => :string,
  optional(:postal_code) => :string,
  optional(:state) => :string
}

Business information about the account.

@type t() :: %Stripe.Account{
  business_profile: term() | nil,
  business_type: binary() | nil,
  capabilities: term(),
  charges_enabled: boolean(),
  company: term(),
  controller: term(),
  country: binary(),
  created: integer(),
  default_currency: binary(),
  details_submitted: boolean(),
  email: binary() | nil,
  external_accounts: term(),
  future_requirements: term(),
  id: binary(),
  individual: Stripe.Person.t(),
  metadata: term(),
  object: binary(),
  payouts_enabled: boolean(),
  requirements: term(),
  settings: term() | nil,
  tos_acceptance: term(),
  type: binary()
}

The account type.

  • business_profile Business information about the account.
  • business_type The business type.
  • capabilities
  • charges_enabled Whether the account can create live charges.
  • company
  • controller
  • country The account's country.
  • created Time at which the account was connected. Measured in seconds since the Unix epoch.
  • default_currency 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.
  • details_submitted Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
  • email An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.
  • external_accounts External accounts (bank accounts and debit cards) currently attached to this account
  • future_requirements
  • id Unique identifier for the object.
  • individual
  • metadata 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.
  • object String representing the object's type. Objects of the same type share the same value.
  • payouts_enabled Whether Stripe can send payouts to this account.
  • requirements
  • settings Options for customizing how the account functions within Stripe.
  • tos_acceptance
  • type The Stripe account type. Can be standard, express, or custom.
Link to this type

tax_reporting_us_1099_k()

View Source
@type tax_reporting_us_1099_k() :: %{optional(:requested) => :boolean}

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.

Link to this type

tax_reporting_us_1099_misc()

View Source
@type tax_reporting_us_1099_misc() :: %{optional(:requested) => :boolean}

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.

@type tos_acceptance() :: %{
  optional(:date) => :integer,
  optional(:ip) => :string,
  optional(:user_agent) => :string
}

Settings specific to the account's Treasury FinancialAccounts.

@type transfers() :: %{optional(:requested) => :boolean}

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.

@type treasury() :: %{tos_acceptance: tos_acceptance()}

Options for customizing how the account functions within Stripe.

Link to this type

us_bank_account_ach_payments()

View Source
@type us_bank_account_ach_payments() :: %{optional(:requested) => :boolean}

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.

@type verification() :: %{
  additional_document: additional_document(),
  document: document()
}

Information about the person represented by the account. This field is null unless business_type is set to individual.

Link to this section Functions

Link to this function

capabilities(client, account, params \\ %{})

View Source
@spec capabilities(
  client :: term(),
  account :: binary(),
  params :: %{optional(:expand) => [:string]}
) ::
  {:ok, Stripe.List.t(Stripe.Capability.t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Details

  • Method: get
  • Path: /v1/accounts/{account}/capabilities
Link to this function

create(client, params \\ %{})

View Source
@spec create(
  client :: term(),
  params :: %{
    optional(:account_token) => :string,
    optional(:business_profile) => business_profile(),
    optional(:business_type) =>
      :company | :government_entity | :individual | :non_profit,
    optional(:capabilities) => capabilities(),
    optional(:company) => company(),
    optional(:country) => :string,
    optional(:default_currency) => :string,
    optional(:documents) => documents(),
    optional(:email) => :string,
    optional(:expand) => [:string],
    optional(:external_account) => :string,
    optional(:individual) => individual(),
    optional(:metadata) => :object | :string,
    optional(:settings) => settings(),
    optional(:tos_acceptance) => tos_acceptance(),
    optional(:type) => :custom | :express | :standard
  }
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

With Connect, you can create Stripe accounts for your users.To do this, you’ll first need to register your platform.

#### Details * Method: `post` * Path: `/v1/accounts`

@spec delete(client :: term(), account :: binary()) ::
  {:ok, Stripe.DeletedAccount.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

With Connect, you can delete accounts you manage.

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.

If you want to delete your own account, use the account information tab in your account settings instead.

Details

  • Method: delete
  • Path: /v1/accounts/{account}
Link to this function

list(client, params \\ %{})

View Source
@spec list(
  client :: term(),
  params :: %{
    optional(:created) => :object | :integer,
    optional(:ending_before) => :string,
    optional(:expand) => [:string],
    optional(:limit) => :integer,
    optional(:starting_after) => :string
  }
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Details

  • Method: get
  • Path: /v1/accounts
Link to this function

persons(client, account, params \\ %{})

View Source
@spec persons(
  client :: term(),
  account :: binary(),
  params :: %{
    optional(:ending_before) => :string,
    optional(:expand) => [:string],
    optional(:limit) => :integer,
    :relationship => relationship(),
    optional(:starting_after) => :string
  }
) ::
  {:ok, Stripe.List.t(Stripe.Person.t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

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.

Details

  • Method: get
  • Path: /v1/accounts/{account}/persons
Link to this function

reject(client, account, params \\ %{})

View Source
@spec reject(
  client :: term(),
  account :: binary(),
  params :: %{optional(:expand) => [:string], reason: :string}
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Details

  • Method: post
  • Path: /v1/accounts/{account}/reject
Link to this function

retrieve(client, params \\ %{})

View Source
@spec retrieve(client :: term(), params :: %{optional(:expand) => [:string]}) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an account.

Details

  • Method: get
  • Path: /v1/account
Link to this function

update(client, account, params \\ %{})

View Source
@spec update(
  client :: term(),
  account :: binary(),
  params :: %{
    optional(:account_token) => :string,
    optional(:business_profile) => business_profile(),
    optional(:business_type) =>
      :company | :government_entity | :individual | :non_profit,
    optional(:capabilities) => capabilities(),
    optional(:company) => company(),
    optional(:default_currency) => :string,
    optional(:documents) => documents(),
    optional(:email) => :string,
    optional(:expand) => [:string],
    optional(:external_account) => :string,
    optional(:individual) => individual(),
    optional(:metadata) => :object | :string,
    optional(:settings) => settings(),
    optional(:tos_acceptance) => tos_acceptance()
  }
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Details

  • Method: post
  • Path: /v1/accounts/{account}