View Source Stripe.Account (stripity_stripe v3.3.1)

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned.

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

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 individual's primary address (Japan only).

affirm_payments()

The affirm_payments capability.

afterpay_clearpay_payments()

The afterpay_clearpay_payments capability.

alma_payments()

The alma_payments capability.

amazon_pay_payments()

The amazon_pay_payments capability.

annual_revenue()

The applicant's gross annual revenue for its preceding fiscal year.

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 check.

bank_transfer_payments()

The bank_transfer_payments capability.

billie_payments()

The billie_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 (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive.

card_issuing()

The card_issuing capability.

card_payments()

Settings specific to card charging on the account.

cartes_bancaires_payments()

The cartes_bancaires_payments capability.

cashapp_payments()

The cashapp_payments capability.

company()

Information about the company or business. This field is available for any business_type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

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.

controller()

A hash of configuration describing the account controller's attributes.

created()
crypto_payments()

The crypto_payments capability.

decline_on()

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

directorship_declaration()

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

dob()
document()

A document verifying the business.

documents()

Documents that may be submitted to satisfy various informational requests.

eps_payments()

The eps_payments capability.

fees()

A hash of configuration for who pays Stripe fees for product usage on this account.

fpx_payments()

The fpx_payments capability.

gb_bank_transfer_payments()

The gb_bank_transfer_payments capability.

giropay_payments()

The giropay_payments capability.

grabpay_payments()

The grabpay_payments capability.

groups()

A hash of account group type to tokens. These are account groups this account should be added to.

ideal_payments()

The ideal_payments capability.

india_international_payments()

The india_international_payments capability.

individual()

Information about the person represented by the account. This field is null unless business_type is set to individual. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

invoices()

Settings specific to the account’s use of Invoices.

jcb_payments()

The jcb_payments capability.

jp_bank_transfer_payments()

The jp_bank_transfer_payments capability.

kakao_pay_payments()

The kakao_pay_payments capability.

klarna_payments()

The klarna_payments capability.

konbini_payments()

The konbini_payments capability.

kr_card_payments()

The kr_card_payments capability.

legacy_payments()

The legacy_payments capability.

link_payments()

The link_payments capability.

losses()

A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.

mb_way_payments()

The mb_way_payments capability.

mobilepay_payments()

The mobilepay_payments capability.

monthly_estimated_revenue()

An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.

multibanco_payments()

The multibanco_payments capability.

mx_bank_transfer_payments()

The mx_bank_transfer_payments capability.

naver_pay_payments()

The naver_pay_payments capability.

nz_bank_account_becs_debit_payments()

The nz_bank_account_becs_debit_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.

pay_by_bank_payments()

The pay_by_bank_payments capability.

payco_payments()

The payco_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.

pix_payments()

The pix_payments capability.

promptpay_payments()

The promptpay_payments capability.

proof_of_address()

One or more documents that demonstrate proof of address.

proof_of_registration()

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

proof_of_ultimate_beneficial_ownership()

One or more documents that demonstrate proof of ultimate beneficial ownership.

registered_address()

The individual's registered address.

registration_date()
relationship()
representative_declaration()

This hash is used to attest that the representative is authorized to act as the representative of their legal entity.

revolut_pay_payments()

The revolut_pay_payments capability.

samsung_pay_payments()

The samsung_pay_payments capability.

satispay_payments()

The satispay_payments capability.

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_bank_transfer_payments()

The sepa_bank_transfer_payments capability.

sepa_debit_payments()

The sepa_debit_payments capability.

settings()

Options for customizing how the account functions within Stripe.

sofort_payments()

The sofort_payments capability.

stripe_dashboard()

A hash of configuration for Stripe-hosted dashboards.

support_address()

A publicly available mailing address for sending support issues to.

swish_payments()

The swish_payments capability.

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 Treasury Services Agreement.

transfers()

The transfers capability.

treasury()

Settings specific to the account's Treasury FinancialAccounts.

twint_payments()

The twint_payments capability.

us_bank_account_ach_payments()

The us_bank_account_ach_payments capability.

us_bank_transfer_payments()

The us_bank_transfer_payments capability.

verification()

Information on the verification state of the company.

zip_payments()

The zip_payments capability.

Functions

capabilities(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(params \\ %{}, opts \\ [])

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

delete(account, opts \\ [])

With Connect, you can delete accounts you manage.

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

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

persons(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(account, params \\ %{}, opts \\ [])

With Connect, you can reject accounts that you have flagged as suspicious.

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

Retrieves the details of an account.

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

Updates a connected account by setting the values of the parameters passed. Any parameters not provided areleft unchanged.

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 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

alma_payments()

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

The alma_payments capability.

Link to this type

amazon_pay_payments()

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

The amazon_pay_payments capability.

Link to this type

annual_revenue()

View Source 
@type annual_revenue() :: %{
  optional(:amount) => integer(),
  optional(:currency) => binary(),
  optional(:fiscal_year_end) => binary()
}

The applicant's gross annual revenue for its preceding fiscal year.

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 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

billie_payments()

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

The billie_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(:annual_revenue) => annual_revenue(),
  optional(:estimated_worker_count) => integer(),
  optional(:mcc) => binary(),
  optional(:minority_owned_business_designation) => [
    :lgbtqi_owned_business
    | :minority_owned_business
    | :none_of_these_apply
    | :prefer_not_to_answer
    | :women_owned_business
  ],
  optional(:monthly_estimated_revenue) => monthly_estimated_revenue(),
  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(:boleto_payments) => boleto_payments(),
  optional(:gb_bank_transfer_payments) => gb_bank_transfer_payments(),
  optional(:satispay_payments) => satispay_payments(),
  optional(:mobilepay_payments) => mobilepay_payments(),
  optional(:revolut_pay_payments) => revolut_pay_payments(),
  optional(:samsung_pay_payments) => samsung_pay_payments(),
  optional(:bank_transfer_payments) => bank_transfer_payments(),
  optional(:acss_debit_payments) => acss_debit_payments(),
  optional(:tax_reporting_us_1099_k) => tax_reporting_us_1099_k(),
  optional(:us_bank_transfer_payments) => us_bank_transfer_payments(),
  optional(:swish_payments) => swish_payments(),
  optional(:cartes_bancaires_payments) => cartes_bancaires_payments(),
  optional(:ideal_payments) => ideal_payments(),
  optional(:bacs_debit_payments) => bacs_debit_payments(),
  optional(:paynow_payments) => paynow_payments(),
  optional(:giropay_payments) => giropay_payments(),
  optional(:amazon_pay_payments) => amazon_pay_payments(),
  optional(:grabpay_payments) => grabpay_payments(),
  optional(:multibanco_payments) => multibanco_payments(),
  optional(:fpx_payments) => fpx_payments(),
  optional(:sepa_debit_payments) => sepa_debit_payments(),
  optional(:legacy_payments) => legacy_payments(),
  optional(:eps_payments) => eps_payments(),
  optional(:sofort_payments) => sofort_payments(),
  optional(:nz_bank_account_becs_debit_payments) =>
    nz_bank_account_becs_debit_payments(),
  optional(:tax_reporting_us_1099_misc) => tax_reporting_us_1099_misc(),
  optional(:us_bank_account_ach_payments) => us_bank_account_ach_payments(),
  optional(:au_becs_debit_payments) => au_becs_debit_payments(),
  optional(:alma_payments) => alma_payments(),
  optional(:crypto_payments) => crypto_payments(),
  optional(:link_payments) => link_payments(),
  optional(:p24_payments) => p24_payments(),
  optional(:jcb_payments) => jcb_payments(),
  optional(:treasury) => treasury(),
  optional(:pay_by_bank_payments) => pay_by_bank_payments(),
  optional(:kr_card_payments) => kr_card_payments(),
  optional(:kakao_pay_payments) => kakao_pay_payments(),
  optional(:oxxo_payments) => oxxo_payments(),
  optional(:india_international_payments) => india_international_payments(),
  optional(:mx_bank_transfer_payments) => mx_bank_transfer_payments(),
  optional(:cashapp_payments) => cashapp_payments(),
  optional(:bancontact_payments) => bancontact_payments(),
  optional(:sepa_bank_transfer_payments) => sepa_bank_transfer_payments(),
  optional(:payco_payments) => payco_payments(),
  optional(:klarna_payments) => klarna_payments(),
  optional(:blik_payments) => blik_payments(),
  optional(:promptpay_payments) => promptpay_payments(),
  optional(:konbini_payments) => konbini_payments(),
  optional(:zip_payments) => zip_payments(),
  optional(:billie_payments) => billie_payments(),
  optional(:afterpay_clearpay_payments) => afterpay_clearpay_payments(),
  optional(:naver_pay_payments) => naver_pay_payments(),
  optional(:card_payments) => card_payments(),
  optional(:jp_bank_transfer_payments) => jp_bank_transfer_payments(),
  optional(:mb_way_payments) => mb_way_payments(),
  optional(:pix_payments) => pix_payments(),
  optional(:transfers) => transfers(),
  optional(:card_issuing) => card_issuing(),
  optional(:affirm_payments) => affirm_payments(),
  optional(:twint_payments) => twint_payments()
}

Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive.

Required when account.controller.stripe_dashboard.type is none, which includes Custom accounts.

Link to this type

card_issuing()

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

The card_issuing capability.

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

cashapp_payments()

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

The cashapp_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(:directorship_declaration) => directorship_declaration(),
  optional(:executives_provided) => boolean(),
  optional(:export_license_id) => binary(),
  optional(:export_purpose_code) => binary(),
  optional(:name) => binary(),
  optional(:name_kana) => binary(),
  optional(:name_kanji) => binary(),
  optional(:owners_provided) => boolean(),
  optional(:ownership_declaration) => ownership_declaration(),
  optional(:ownership_exemption_reason) =>
    :qualified_entity_exceeds_ownership_threshold
    | :qualifies_as_financial_institution,
  optional(:phone) => binary(),
  optional(:registration_date) => registration_date() | binary(),
  optional(:registration_number) => binary(),
  optional(:representative_declaration) => representative_declaration(),
  optional(:structure) =>
    :free_zone_establishment
    | :free_zone_llc
    | :government_instrumentality
    | :governmental_unit
    | :incorporated_non_profit
    | :incorporated_partnership
    | :limited_liability_partnership
    | :llc
    | :multi_member_llc
    | :private_company
    | :private_corporation
    | :private_partnership
    | :public_company
    | :public_corporation
    | :public_partnership
    | :registered_charity
    | :single_member_llc
    | :sole_establishment
    | :sole_proprietorship
    | :tax_exempt_government_instrumentality
    | :unincorporated_association
    | :unincorporated_non_profit
    | :unincorporated_partnership,
  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. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

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

controller()

View Source 
@type controller() :: %{
  optional(:fees) => fees(),
  optional(:losses) => losses(),
  optional(:requirement_collection) => :application | :stripe,
  optional(:stripe_dashboard) => stripe_dashboard()
}

A hash of configuration describing the account controller's attributes.

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

crypto_payments()

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

The crypto_payments capability.

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

directorship_declaration()

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

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

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()}

A document verifying the business.

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_address) => proof_of_address(),
  optional(:proof_of_registration) => proof_of_registration(),
  optional(:proof_of_ultimate_beneficial_ownership) =>
    proof_of_ultimate_beneficial_ownership()
}

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

fees()

View Source 
@type fees() :: %{optional(:payer) => :account | :application}

A hash of configuration for who pays Stripe fees for product usage on this account.

Link to this type

fpx_payments()

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

The fpx_payments capability.

Link to this type

gb_bank_transfer_payments()

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

The gb_bank_transfer_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

groups()

View Source 
@type groups() :: %{optional(:payments_pricing) => binary() | binary()}

A hash of account group type to tokens. These are account groups this account should be added to.

Link to this type

ideal_payments()

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

The ideal_payments capability.

Link to this type

india_international_payments()

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

The india_international_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(:relationship) => relationship(),
  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. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is application, which includes Custom accounts.

Link to this type

invoices()

View Source 
@type invoices() :: %{
  optional(:hosted_payment_method_save) => :always | :never | :offer
}

Settings specific to the account’s use of Invoices.

Link to this type

jcb_payments()

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

The jcb_payments capability.

Link to this type

jp_bank_transfer_payments()

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

The jp_bank_transfer_payments capability.

Link to this type

kakao_pay_payments()

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

The kakao_pay_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

kr_card_payments()

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

The kr_card_payments capability.

Link to this type

legacy_payments()

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

The legacy_payments capability.

Link to this type

losses()

View Source 
@type losses() :: %{optional(:payments) => :application | :stripe}

A hash of configuration for products that have negative balance liability, and whether Stripe or a Connect application is responsible for them.

Link to this type

mb_way_payments()

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

The mb_way_payments capability.

Link to this type

mobilepay_payments()

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

The mobilepay_payments capability.

Link to this type

monthly_estimated_revenue()

View Source 
@type monthly_estimated_revenue() :: %{
  optional(:amount) => integer(),
  optional(:currency) => binary()
}

An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.

Link to this type

multibanco_payments()

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

The multibanco_payments capability.

Link to this type

mx_bank_transfer_payments()

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

The mx_bank_transfer_payments capability.

Link to this type

naver_pay_payments()

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

The naver_pay_payments capability.

Link to this type

nz_bank_account_becs_debit_payments()

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

The nz_bank_account_becs_debit_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

pay_by_bank_payments()

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

The pay_by_bank_payments capability.

Link to this type

payco_payments()

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

The payco_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

pix_payments()

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

The pix_payments capability.

Link to this type

promptpay_payments()

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

The promptpay_payments capability.

Link to this type

proof_of_address()

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

One or more documents that demonstrate proof of address.

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

proof_of_ultimate_beneficial_ownership()

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

One or more documents that demonstrate proof of ultimate beneficial ownership.

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

registration_date()

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

relationship()

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

representative_declaration()

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

This hash is used to attest that the representative is authorized to act as the representative of their legal entity.

Link to this type

revolut_pay_payments()

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

The revolut_pay_payments capability.

Link to this type

samsung_pay_payments()

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

The samsung_pay_payments capability.

Link to this type

satispay_payments()

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

The satispay_payments capability.

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(:monthly_payout_days) => [integer()],
  optional(:weekly_anchor) =>
    :friday | :monday | :saturday | :sunday | :thursday | :tuesday | :wednesday,
  optional(:weekly_payout_days) => [
    :friday | :monday | :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_bank_transfer_payments()

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

The sepa_bank_transfer_payments capability.

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(:bacs_debit_payments) => bacs_debit_payments(),
  optional(:branding) => branding(),
  optional(:card_issuing) => card_issuing(),
  optional(:card_payments) => card_payments(),
  optional(:invoices) => invoices(),
  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

stripe_dashboard()

View Source 
@type stripe_dashboard() :: %{optional(:type) => :express | :full | :none}

A hash of configuration for Stripe-hosted dashboards.

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

swish_payments()

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

The swish_payments capability.

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(),
  groups: term() | nil,
  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 process 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. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.
  • email An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
  • external_accounts External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.
  • future_requirements
  • groups The groups associated with the account.
  • 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 the funds in this account can be paid out.
  • requirements
  • settings Options for customizing how the account functions within Stripe.
  • tos_acceptance
  • type The Stripe account type. Can be standard, express, custom, or none.
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() | binary()
}

Details on the account's acceptance of the Stripe Treasury Services Agreement.

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

twint_payments()

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

The twint_payments capability.

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

us_bank_transfer_payments()

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

The us_bank_transfer_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 type

zip_payments()

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

The zip_payments capability.

Functions

Link to this function

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

View Source 
@spec capabilities(
  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(params \\ %{}, opts \\ [])

View Source 
@spec create(
  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(:controller) => controller(),
    optional(:country) => binary(),
    optional(:default_currency) => binary(),
    optional(:documents) => documents(),
    optional(:email) => binary(),
    optional(:expand) => [binary()],
    optional(:external_account) => binary(),
    optional(:groups) => groups(),
    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.

If you’ve already collected information for your connected accounts, you can prefill that information whencreating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.

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

Link to this function

delete(account, opts \\ [])

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

With Connect, you can delete accounts you manage.

Test-mode accounts can be deleted at any time.

Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all balances are zero.

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

Details

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

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

View Source 
@spec list(
  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(account, params \\ %{}, opts \\ [])

View Source 
@spec persons(
  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(account, params \\ %{}, opts \\ [])

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

With Connect, you can reject accounts that you have flagged as suspicious.

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

Details

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

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

View Source 
@spec retrieve(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(account, params \\ %{}, opts \\ [])

View Source 
@spec update(
  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(:groups) => groups(),
    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 areleft unchanged.

For accounts where controller.requirement_collectionis application, which includes Custom accounts, you can update any information on the account.

For accounts where controller.requirement_collectionis stripe, which includes Standard and Express accounts, you can update all information until you create an Account Link or Account Session to start Connect onboarding, after which some properties can no longer be updated.

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

#### Details * Method: `post` * Path: `/v1/accounts/{account}`