Stripe.Params.AccountSessionCreateParams (tiger_stripe v0.3.0)

@type components() :: %{
  optional(:account_management) => components_account_management() | nil,
  optional(:account_onboarding) => components_account_onboarding() | nil,
  optional(:balances) => components_balances() | nil,
  optional(:disputes_list) => components_disputes_list() | nil,
  optional(:documents) => components_documents() | nil,
  optional(:financial_account) => components_financial_account() | nil,
  optional(:financial_account_transactions) =>
    components_financial_account_transactions() | nil,
  optional(:instant_payouts_promotion) =>
    components_instant_payouts_promotion() | nil,
  optional(:issuing_card) => components_issuing_card() | nil,
  optional(:issuing_cards_list) => components_issuing_cards_list() | nil,
  optional(:notification_banner) => components_notification_banner() | nil,
  optional(:payment_details) => components_payment_details() | nil,
  optional(:payment_disputes) => components_payment_disputes() | nil,
  optional(:payments) => components_payments() | nil,
  optional(:payout_details) => components_payout_details() | nil,
  optional(:payouts) => components_payouts() | nil,
  optional(:payouts_list) => components_payouts_list() | nil,
  optional(:tax_registrations) => components_tax_registrations() | nil,
  optional(:tax_settings) => components_tax_settings() | nil,
  optional(String.t()) => term()
}

account_management - Configuration for the account management embedded component.
account_onboarding - Configuration for the account onboarding embedded component.
balances - Configuration for the balances embedded component.
disputes_list - Configuration for the disputes list embedded component.
documents - Configuration for the documents embedded component.
financial_account - Configuration for the financial account embedded component.
financial_account_transactions - Configuration for the financial account transactions embedded component.
instant_payouts_promotion - Configuration for the instant payouts promotion embedded component.
issuing_card - Configuration for the issuing card embedded component.
issuing_cards_list - Configuration for the issuing cards list embedded component.
notification_banner - Configuration for the notification banner embedded component.
payment_details - Configuration for the payment details embedded component.
payment_disputes - Configuration for the payment disputes embedded component.
payments - Configuration for the payments embedded component.
payout_details - Configuration for the payout details embedded component.
payouts - Configuration for the payouts embedded component.
payouts_list - Configuration for the payouts list embedded component.
tax_registrations - Configuration for the tax registrations embedded component.
tax_settings - Configuration for the tax settings embedded component.

components_account_management()

@type components_account_management() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_account_management_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_account_management_features()

@type components_account_management_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.

components_account_onboarding()

@type components_account_onboarding() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_account_onboarding_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_account_onboarding_features()

@type components_account_onboarding_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.

components_balances()

@type components_balances() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_balances_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_balances_features()

@type components_balances_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:edit_payout_schedule) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(:instant_payouts) => boolean() | nil,
  optional(:standard_payouts) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
edit_payout_schedule - Whether to allow payout schedule to be changed. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.
instant_payouts - Whether instant payouts are enabled for this component.
standard_payouts - Whether to allow creation of standard payouts. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.

components_disputes_list()

@type components_disputes_list() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_disputes_list_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_disputes_list_features()

@type components_disputes_list_features() :: %{
  optional(:capture_payments) => boolean() | nil,
  optional(:destination_on_behalf_of_charge_management) => boolean() | nil,
  optional(:dispute_management) => boolean() | nil,
  optional(:refund_management) => boolean() | nil,
  optional(String.t()) => term()
}

capture_payments - Whether to allow capturing and cancelling payment intents. This is true by default.
destination_on_behalf_of_charge_management - Whether connected accounts can manage destination charges that are created on behalf of them. This is false by default.
dispute_management - Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
refund_management - Whether sending refunds is enabled. This is true by default.

components_documents()

@type components_documents() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => map() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - An empty list, because this embedded component has no features.

components_financial_account()

@type components_financial_account() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_financial_account_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_financial_account_features()

@type components_financial_account_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(:send_money) => boolean() | nil,
  optional(:transfer_balance) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.
send_money - Whether to allow sending money.
transfer_balance - Whether to allow transferring balance.

components_financial_account_transactions()

@type components_financial_account_transactions() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) =>
    components_financial_account_transactions_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_financial_account_transactions_features()

@type components_financial_account_transactions_features() :: %{
  optional(:card_spend_dispute_management) => boolean() | nil,
  optional(String.t()) => term()
}

card_spend_dispute_management - Whether to allow card spend dispute management features.

components_instant_payouts_promotion()

@type components_instant_payouts_promotion() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_instant_payouts_promotion_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_instant_payouts_promotion_features()

@type components_instant_payouts_promotion_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(:instant_payouts) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.
instant_payouts - Whether instant payouts are enabled for this component.

components_issuing_card()

@type components_issuing_card() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_issuing_card_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_issuing_card_features()

@type components_issuing_card_features() :: %{
  optional(:card_management) => boolean() | nil,
  optional(:card_spend_dispute_management) => boolean() | nil,
  optional(:cardholder_management) => boolean() | nil,
  optional(:spend_control_management) => boolean() | nil,
  optional(String.t()) => term()
}

card_management - Whether to allow card management features.
card_spend_dispute_management - Whether to allow card spend dispute management features.
cardholder_management - Whether to allow cardholder management features.
spend_control_management - Whether to allow spend control management features.

components_issuing_cards_list()

@type components_issuing_cards_list() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_issuing_cards_list_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_issuing_cards_list_features()

@type components_issuing_cards_list_features() :: %{
  optional(:card_management) => boolean() | nil,
  optional(:card_spend_dispute_management) => boolean() | nil,
  optional(:cardholder_management) => boolean() | nil,
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:spend_control_management) => boolean() | nil,
  optional(String.t()) => term()
}

card_management - Whether to allow card management features.
card_spend_dispute_management - Whether to allow card spend dispute management features.
cardholder_management - Whether to allow cardholder management features.
disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
spend_control_management - Whether to allow spend control management features.

components_notification_banner()

@type components_notification_banner() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_notification_banner_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_notification_banner_features()

@type components_notification_banner_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.

components_payment_details()

@type components_payment_details() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_payment_details_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_payment_details_features()

@type components_payment_details_features() :: %{
  optional(:capture_payments) => boolean() | nil,
  optional(:destination_on_behalf_of_charge_management) => boolean() | nil,
  optional(:dispute_management) => boolean() | nil,
  optional(:refund_management) => boolean() | nil,
  optional(String.t()) => term()
}

capture_payments - Whether to allow capturing and cancelling payment intents. This is true by default.
destination_on_behalf_of_charge_management - Whether connected accounts can manage destination charges that are created on behalf of them. This is false by default.
dispute_management - Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
refund_management - Whether sending refunds is enabled. This is true by default.

components_payment_disputes()

@type components_payment_disputes() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_payment_disputes_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_payment_disputes_features()

@type components_payment_disputes_features() :: %{
  optional(:destination_on_behalf_of_charge_management) => boolean() | nil,
  optional(:dispute_management) => boolean() | nil,
  optional(:refund_management) => boolean() | nil,
  optional(String.t()) => term()
}

destination_on_behalf_of_charge_management - Whether connected accounts can manage destination charges that are created on behalf of them. This is false by default.
dispute_management - Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
refund_management - Whether sending refunds is enabled. This is true by default.

components_payments()

@type components_payments() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_payments_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_payments_features()

@type components_payments_features() :: %{
  optional(:capture_payments) => boolean() | nil,
  optional(:destination_on_behalf_of_charge_management) => boolean() | nil,
  optional(:dispute_management) => boolean() | nil,
  optional(:refund_management) => boolean() | nil,
  optional(String.t()) => term()
}

capture_payments - Whether to allow capturing and cancelling payment intents. This is true by default.
destination_on_behalf_of_charge_management - Whether connected accounts can manage destination charges that are created on behalf of them. This is false by default.
dispute_management - Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
refund_management - Whether sending refunds is enabled. This is true by default.

components_payout_details()

@type components_payout_details() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => map() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - An empty list, because this embedded component has no features.

components_payouts()

@type components_payouts() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => components_payouts_features() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - The list of features enabled in the embedded component.

components_payouts_features()

@type components_payouts_features() :: %{
  optional(:disable_stripe_user_authentication) => boolean() | nil,
  optional(:edit_payout_schedule) => boolean() | nil,
  optional(:external_account_collection) => boolean() | nil,
  optional(:instant_payouts) => boolean() | nil,
  optional(:standard_payouts) => boolean() | nil,
  optional(String.t()) => term()
}

disable_stripe_user_authentication - Whether Stripe user authentication is disabled. This value can only be true for accounts where controller.requirement_collection is application for the account. The default value is the opposite of the external_account_collection value. For example, if you don't set external_account_collection, it defaults to true and disable_stripe_user_authentication defaults to false.
edit_payout_schedule - Whether to allow payout schedule to be changed. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
external_account_collection - Whether external account collection is enabled. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is true.
instant_payouts - Whether instant payouts are enabled for this component.
standard_payouts - Whether to allow creation of standard payouts. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.

components_payouts_list()

@type components_payouts_list() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => map() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - An empty list, because this embedded component has no features.

components_tax_registrations()

@type components_tax_registrations() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => map() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - An empty list, because this embedded component has no features.

components_tax_settings()

@type components_tax_settings() :: %{
  optional(:enabled) => boolean() | nil,
  optional(:features) => map() | nil,
  optional(String.t()) => term()
}

enabled - Whether the embedded component is enabled.
features - An empty list, because this embedded component has no features.

t()

@type t() :: %Stripe.Params.AccountSessionCreateParams{
  account: String.t(),
  components: components(),
  expand: [String.t()] | nil
}

account - The identifier of the account to create an Account Session for.
components - Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
expand - Specifies which fields in the response should be expanded.