Striped v0.5.0

View Source Stripe.Account (Striped v0.5.0) (generated)

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

acss_debit_payments()

The acss_debit_payments capability.

additional_document()

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

address()

The company's primary address.

address_kana()

The Kana variation of the company's primary address (Japan only).

address_kanji()

The Kanji variation of the the individual's primary address (Japan only).

affirm_payments()

The affirm_payments capability.

afterpay_clearpay_payments()

The afterpay_clearpay_payments capability.

au_becs_debit_payments()

The au_becs_debit_payments capability.

bacs_debit_payments()

The bacs_debit_payments capability.

bancontact_payments()

The bancontact_payments capability.

bank_account_ownership_verification()

One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.

bank_transfer_payments()

The bank_transfer_payments capability.

blik_payments()

The blik_payments capability.

boleto_payments()

The boleto_payments capability.

branding()

Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.

business_profile()

Business information about the account.

capabilities()

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.

card_issuing()

Settings specific to the account's use of the Card Issuing product.

card_payments()

Settings specific to card charging on the account.

cartes_bancaires_payments()

The cartes_bancaires_payments capability.

company()

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

company_license()

One or more documents that demonstrate proof of a company's license to operate.

company_memorandum_of_association()

One or more documents showing the company's Memorandum of Association.

company_ministerial_decree()

(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.

company_registration_verification()

One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.

company_tax_id_verification()

One or more documents that demonstrate proof of a company's tax ID.

created()
decline_on()

Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.

dob()
document()

An identifying document, either a passport or local ID card.

documents()

Documents that may be submitted to satisfy various informational requests.

eps_payments()

The eps_payments capability.

fpx_payments()

The fpx_payments capability.

giropay_payments()

The giropay_payments capability.

grabpay_payments()

The grabpay_payments capability.

ideal_payments()

The ideal_payments capability.

individual()

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

jcb_payments()

The jcb_payments capability.

klarna_payments()

The klarna_payments capability.

konbini_payments()

The konbini_payments capability.

legacy_payments()

The legacy_payments capability.

link_payments()

The link_payments capability.

ownership_declaration()

This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.

oxxo_payments()

The oxxo_payments capability.

p24_payments()

The p24_payments capability.

payments()

Settings that apply across payment methods for charging on the account.

paynow_payments()

The paynow_payments capability.

payouts()

Settings specific to the account's payouts.

promptpay_payments()

The promptpay_payments capability.

proof_of_registration()

One or more documents showing the company’s proof of registration with the national business registry.

registered_address()

The individual's registered address.

relationship()
schedule()

Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.

sepa_debit_payments()

The sepa_debit_payments capability.

settings()

Options for customizing how the account functions within Stripe.

sofort_payments()

The sofort_payments capability.

support_address()

A publicly available mailing address for sending support issues to.

t()

The account type.

tax_reporting_us_1099_k()

The tax_reporting_us_1099_k capability.

tax_reporting_us_1099_misc()

The tax_reporting_us_1099_misc capability.

tos_acceptance()

Details on the account's acceptance of the Stripe Issuing Terms and Disclosures.

transfers()

The transfers capability.

treasury()

Settings specific to the account's Treasury FinancialAccounts.

us_bank_account_ach_payments()

The us_bank_account_ach_payments capability.

verification()

Information on the verification state of the company.

Functions

capabilities(client, account, params \\ %{}, opts \\ [])

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

create(client, params \\ %{}, opts \\ [])

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

delete(client, account, opts \\ [])

With Connect, you can delete accounts you manage.

list(client, params \\ %{}, opts \\ [])

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

persons(client, account, params \\ %{}, opts \\ [])

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.

reject(client, account, params \\ %{}, opts \\ [])

With Connect, you may flag accounts as suspicious.

retrieve(client, params \\ %{}, opts \\ [])

Retrieves the details of an account.

update(client, account, params \\ %{}, opts \\ [])

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

Link to this type

acss_debit_payments()

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

The acss_debit_payments capability.

Link to this type

additional_document()

View Source 
@type additional_document() :: %{
  optional(:back) => binary(),
  optional(:front) => binary()
}

A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.

Link to this type

address()

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

The company's primary address.

Link to this type

address_kana()

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

The Kana variation of the company's primary address (Japan only).

Link to this type

address_kanji()

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

The Kanji variation of the the individual's primary address (Japan only).

Link to this type

affirm_payments()

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

The affirm_payments capability.

Link to this type

afterpay_clearpay_payments()

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

The afterpay_clearpay_payments capability.

Link to this type

au_becs_debit_payments()

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

The au_becs_debit_payments capability.

Link to this type

bacs_debit_payments()

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

The bacs_debit_payments capability.

Link to this type

bancontact_payments()

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

The bancontact_payments capability.

Link to this type

bank_account_ownership_verification()

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

One or more documents that support the Bank account ownership verification requirement. Must be a document associated with the account’s primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.

Link to this type

bank_transfer_payments()

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

The bank_transfer_payments capability.

Link to this type

blik_payments()

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

The blik_payments capability.

Link to this type

boleto_payments()

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

The boleto_payments capability.

Link to this type

branding()

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

Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.

Link to this type

business_profile()

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

Business information about the account.

Link to this type

capabilities()

View Source 
@type capabilities() :: %{
  optional(:link_payments) => link_payments(),
  optional(:card_issuing) => card_issuing(),
  optional(:treasury) => treasury(),
  optional(:oxxo_payments) => oxxo_payments(),
  optional(:affirm_payments) => affirm_payments(),
  optional(:promptpay_payments) => promptpay_payments(),
  optional(:bank_transfer_payments) => bank_transfer_payments(),
  optional(:sofort_payments) => sofort_payments(),
  optional(:acss_debit_payments) => acss_debit_payments(),
  optional(:cartes_bancaires_payments) => cartes_bancaires_payments(),
  optional(:bacs_debit_payments) => bacs_debit_payments(),
  optional(:tax_reporting_us_1099_misc) => tax_reporting_us_1099_misc(),
  optional(:paynow_payments) => paynow_payments(),
  optional(:klarna_payments) => klarna_payments(),
  optional(:us_bank_account_ach_payments) => us_bank_account_ach_payments(),
  optional(:card_payments) => card_payments(),
  optional(:p24_payments) => p24_payments(),
  optional(:boleto_payments) => boleto_payments(),
  optional(:fpx_payments) => fpx_payments(),
  optional(:au_becs_debit_payments) => au_becs_debit_payments(),
  optional(:konbini_payments) => konbini_payments(),
  optional(:ideal_payments) => ideal_payments(),
  optional(:afterpay_clearpay_payments) => afterpay_clearpay_payments(),
  optional(:blik_payments) => blik_payments(),
  optional(:bancontact_payments) => bancontact_payments(),
  optional(:giropay_payments) => giropay_payments(),
  optional(:legacy_payments) => legacy_payments(),
  optional(:sepa_debit_payments) => sepa_debit_payments(),
  optional(:transfers) => transfers(),
  optional(:eps_payments) => eps_payments(),
  optional(:grabpay_payments) => grabpay_payments(),
  optional(:tax_reporting_us_1099_k) => tax_reporting_us_1099_k(),
  optional(: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.

Link to this type

card_issuing()

View Source 
@type card_issuing() :: %{optional(:tos_acceptance) => tos_acceptance()}

Settings specific to the account's use of the Card Issuing product.

Link to this type

card_payments()

View Source 
@type card_payments() :: %{
  optional(:decline_on) => decline_on(),
  optional(:statement_descriptor_prefix) => binary(),
  optional(:statement_descriptor_prefix_kana) => binary() | binary(),
  optional(:statement_descriptor_prefix_kanji) => binary() | binary()
}

Settings specific to card charging on the account.

Link to this type

cartes_bancaires_payments()

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

The cartes_bancaires_payments capability.

Link to this type

company()

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

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

Link to this type

company_license()

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

One or more documents that demonstrate proof of a company's license to operate.

Link to this type

company_memorandum_of_association()

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

One or more documents showing the company's Memorandum of Association.

Link to this type

company_ministerial_decree()

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

(Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.

Link to this type

company_registration_verification()

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

One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.

Link to this type

company_tax_id_verification()

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

One or more documents that demonstrate proof of a company's tax ID.

Link to this type

created()

View Source 
@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}
Link to this type

decline_on()

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

Automatically declines certain charge types regardless of whether the card issuer accepted or declined the charge.

Link to this type

dob()

View Source 
@type dob() :: %{
  optional(:day) => integer(),
  optional(:month) => integer(),
  optional(:year) => integer()
}
Link to this type

document()

View Source 
@type document() :: %{optional(:back) => binary(), optional(:front) => binary()}

An identifying document, either a passport or local ID card.

Link to this type

documents()

View Source 
@type documents() :: %{
  optional(:bank_account_ownership_verification) =>
    bank_account_ownership_verification(),
  optional(:company_license) => company_license(),
  optional(:company_memorandum_of_association) =>
    company_memorandum_of_association(),
  optional(:company_ministerial_decree) => company_ministerial_decree(),
  optional(:company_registration_verification) =>
    company_registration_verification(),
  optional(:company_tax_id_verification) => company_tax_id_verification(),
  optional(:proof_of_registration) => proof_of_registration()
}

Documents that may be submitted to satisfy various informational requests.

Link to this type

eps_payments()

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

The eps_payments capability.

Link to this type

fpx_payments()

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

The fpx_payments capability.

Link to this type

giropay_payments()

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

The giropay_payments capability.

Link to this type

grabpay_payments()

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

The grabpay_payments capability.

Link to this type

ideal_payments()

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

The ideal_payments capability.

Link to this type

individual()

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

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

Link to this type

jcb_payments()

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

The jcb_payments capability.

Link to this type

klarna_payments()

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

The klarna_payments capability.

Link to this type

konbini_payments()

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

The konbini_payments capability.

Link to this type

legacy_payments()

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

The legacy_payments capability.

Link to this type

ownership_declaration()

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

This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.

Link to this type

oxxo_payments()

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

The oxxo_payments capability.

Link to this type

p24_payments()

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

The p24_payments capability.

Link to this type

payments()

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

Settings that apply across payment methods for charging on the account.

Link to this type

paynow_payments()

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

The paynow_payments capability.

Link to this type

payouts()

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

Settings specific to the account's payouts.

Link to this type

promptpay_payments()

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

The promptpay_payments capability.

Link to this type

proof_of_registration()

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

One or more documents showing the company’s proof of registration with the national business registry.

Link to this type

registered_address()

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

The individual's registered address.

Link to this type

relationship()

View Source 
@type relationship() :: %{
  optional(:director) => boolean(),
  optional(:executive) => boolean(),
  optional(:owner) => boolean(),
  optional(:representative) => boolean()
}
Link to this type

schedule()

View Source 
@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
}

Details on when funds from charges are available, and when they are paid out to an external account. For details, see our Setting Bank and Debit Card Payouts documentation.

Link to this type

sepa_debit_payments()

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

The sepa_debit_payments capability.

Link to this type

settings()

View Source 
@type settings() :: %{
  optional(:branding) => branding(),
  optional(:card_issuing) => card_issuing(),
  optional(:card_payments) => card_payments(),
  optional(:payments) => payments(),
  optional(:payouts) => payouts(),
  optional(:treasury) => treasury()
}

Options for customizing how the account functions within Stripe.

Link to this type

sofort_payments()

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

The sofort_payments capability.

Link to this type

support_address()

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

A publicly available mailing address for sending support issues to.

Link to this type

t()

View Source 
@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()}

The tax_reporting_us_1099_k capability.

Link to this type

tax_reporting_us_1099_misc()

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

The tax_reporting_us_1099_misc capability.

Link to this type

tos_acceptance()

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

Details on the account's acceptance of the Stripe Issuing Terms and Disclosures.

Link to this type

transfers()

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

The transfers capability.

Link to this type

treasury()

View Source 
@type treasury() :: %{optional(:tos_acceptance) => tos_acceptance()}

Settings specific to the account's Treasury FinancialAccounts.

Link to this type

us_bank_account_ach_payments()

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

The us_bank_account_ach_payments capability.

Link to this type

verification()

View Source 
@type verification() :: %{optional(:document) => document()}

Information on the verification state of the company.

Link to this section Functions

Link to this function

capabilities(client, account, params \\ %{}, opts \\ [])

View Source 
@spec capabilities(
  client :: Stripe.t(),
  account :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) ::
  {: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 \\ %{}, opts \\ [])

View Source 
@spec create(
  client :: Stripe.t(),
  params :: %{
    optional(:account_token) => binary(),
    optional(:business_profile) => business_profile(),
    optional(:business_type) =>
      :company | :government_entity | :individual | :non_profit,
    optional(:capabilities) => capabilities(),
    optional(:company) => company(),
    optional(:country) => binary(),
    optional(:default_currency) => binary(),
    optional(:documents) => documents(),
    optional(:email) => binary(),
    optional(:expand) => [binary()],
    optional(:external_account) => binary(),
    optional(:individual) => individual(),
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:settings) => settings(),
    optional(:tos_acceptance) => tos_acceptance(),
    optional(:type) => :custom | :express | :standard
  },
  opts :: Keyword.t()
) :: {: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
Link to this function

delete(client, account, opts \\ [])

View Source 
@spec delete(client :: Stripe.t(), account :: binary(), opts :: Keyword.t()) ::
  {: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 \\ %{}, opts \\ [])

View Source 
@spec list(
  client :: Stripe.t(),
  params :: %{
    optional(:created) => created() | integer(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {: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 \\ %{}, opts \\ [])

View Source 
@spec persons(
  client :: Stripe.t(),
  account :: binary(),
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:relationship) => relationship(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {: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 \\ %{}, opts \\ [])

View Source 
@spec reject(
  client :: Stripe.t(),
  account :: binary(),
  params :: %{optional(:expand) => [binary()], optional(:reason) => binary()},
  opts :: Keyword.t()
) :: {: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 \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  client :: Stripe.t(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) ::
  {: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 \\ %{}, opts \\ [])

View Source 
@spec update(
  client :: Stripe.t(),
  account :: binary(),
  params :: %{
    optional(:account_token) => binary(),
    optional(:business_profile) => business_profile(),
    optional(:business_type) =>
      :company | :government_entity | :individual | :non_profit,
    optional(:capabilities) => capabilities(),
    optional(:company) => company(),
    optional(:default_currency) => binary(),
    optional(:documents) => documents(),
    optional(:email) => binary(),
    optional(:expand) => [binary()],
    optional(:external_account) => binary(),
    optional(:individual) => individual(),
    optional(:metadata) => %{optional(binary()) => binary()} | binary(),
    optional(:settings) => settings(),
    optional(:tos_acceptance) => tos_acceptance()
  },
  opts :: Keyword.t()
) :: {: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}