Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
Parameters
- accountstringRequired
The identifier of the account to create an Account Session for.
- componentsobjectRequired
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).
- components.
account_ managementobject Configuration for the account management embedded component.
- components.
account_management. enabledbooleanRequired Whether the embedded component is enabled.
- components.
account_management. featuresobject The list of features enabled in the embedded component.
- components.
account_management. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
account_management. features. external_ account_ collectionboolean Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is
true
.
- components.
account_ onboardingobject Configuration for the account onboarding embedded component.
- components.
account_onboarding. enabledbooleanRequired Whether the embedded component is enabled.
- components.
account_onboarding. featuresobject The list of features enabled in the embedded component.
- components.
account_onboarding. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
account_onboarding. features. external_ account_ collectionboolean Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is
true
.
- components.
balancesobject Configuration for the balances embedded component.
- components.
balances. enabledbooleanRequired Whether the embedded component is enabled.
- components.
balances. featuresobject The list of features enabled in the embedded component.
- components.
balances. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
balances. features. edit_ payout_ scheduleboolean Whether to allow payout schedule to be changed. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise. - components.
balances. features. external_ account_ collectionboolean Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is
true
. - components.
balances. features. instant_ payoutsboolean Whether to allow creation of instant payouts. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise. - components.
balances. features. standard_ payoutsboolean Whether to allow creation of standard payouts. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise.
- components.
disputes_ listobject Configuration for the disputes list embedded component.
- components.
disputes_list. enabledbooleanRequired Whether the embedded component is enabled.
- components.
disputes_list. featuresobject The list of features enabled in the embedded component.
- components.
disputes_list. features. capture_ paymentsboolean Whether to allow capturing and cancelling payment intents. This is
true
by default. - components.
disputes_list. features. destination_ on_ behalf_ of_ charge_ managementboolean Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is
false
by default. - components.
disputes_list. features. dispute_ managementboolean Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is
true
by default. - components.
disputes_list. features. refund_ managementboolean Whether to allow sending refunds. This is
true
by default.
- components.
documentsobject Configuration for the documents embedded component.
- components.
documents. enabledbooleanRequired Whether the embedded component is enabled.
- components.
documents. featuresobject The list of features enabled in the embedded component.
- components.
financial_ accountobject Configuration for the financial account embedded component.
- components.
financial_account. enabledbooleanRequired Whether the embedded component is enabled.
- components.
financial_account. featuresobject The list of features enabled in the embedded component.
- components.
financial_account. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
financial_account. features. external_ account_ collectionboolean Whether to allow external accounts to be linked for money transfer.
- components.
financial_account. features. send_ moneyboolean Whether to allow sending money.
- components.
financial_account. features. transfer_ balanceboolean Whether to allow transferring balance.
- components.
financial_ account_ transactionsobject Configuration for the financial account transactions embedded component.
- components.
financial_account_transactions. enabledbooleanRequired Whether the embedded component is enabled.
- components.
financial_account_transactions. featuresobject The list of features enabled in the embedded component.
- components.
financial_account_transactions. features. card_ spend_ dispute_ managementboolean Whether to allow card spend dispute management features.
- components.
issuing_ cardobject Configuration for the issuing card embedded component.
- components.
issuing_card. enabledbooleanRequired Whether the embedded component is enabled.
- components.
issuing_card. featuresobject The list of features enabled in the embedded component.
- components.
issuing_card. features. card_ managementboolean Whether to allow card management features.
- components.
issuing_card. features. card_ spend_ dispute_ managementboolean Whether to allow card spend dispute management features.
- components.
issuing_card. features. cardholder_ managementboolean Whether to allow cardholder management features.
- components.
issuing_card. features. spend_ control_ managementboolean Whether to allow spend control management features.
- components.
issuing_ cards_ listobject Configuration for the issuing cards list embedded component.
- components.
issuing_cards_list. enabledbooleanRequired Whether the embedded component is enabled.
- components.
issuing_cards_list. featuresobject The list of features enabled in the embedded component.
- components.
issuing_cards_list. features. card_ managementboolean Whether to allow card management features.
- components.
issuing_cards_list. features. card_ spend_ dispute_ managementboolean Whether to allow card spend dispute management features.
- components.
issuing_cards_list. features. cardholder_ managementboolean Whether to allow cardholder management features.
- components.
issuing_cards_list. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. 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.
- components.
issuing_cards_list. features. spend_ control_ managementboolean Whether to allow spend control management features.
- components.
object Configuration for the notification banner embedded component.
- components.
notification_banner. booleanRequired Whether the embedded component is enabled.
- components.
notification_banner. object The list of features enabled in the embedded component.
- components.
notification_banner. features. boolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
notification_banner. features. boolean Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is
true
.
- components.
payment_ detailsobject Configuration for the payment details embedded component.
- components.
payment_details. enabledbooleanRequired Whether the embedded component is enabled.
- components.
payment_details. featuresobject The list of features enabled in the embedded component.
- components.
payment_details. features. capture_ paymentsboolean Whether to allow capturing and cancelling payment intents. This is
true
by default. - components.
payment_details. features. destination_ on_ behalf_ of_ charge_ managementboolean Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is
false
by default. - components.
payment_details. features. dispute_ managementboolean Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is
true
by default. - components.
payment_details. features. refund_ managementboolean Whether to allow sending refunds. This is
true
by default.
- components.
payment_ disputesobject Configuration for the payment disputes embedded component.
- components.
payment_disputes. enabledbooleanRequired Whether the embedded component is enabled.
- components.
payment_disputes. featuresobject The list of features enabled in the embedded component.
- components.
payment_disputes. features. destination_ on_ behalf_ of_ charge_ managementboolean Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is
false
by default. - components.
payment_disputes. features. dispute_ managementboolean Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is
true
by default. - components.
payment_disputes. features. refund_ managementboolean Whether to allow sending refunds. This is
true
by default.
- components.
paymentsobject Configuration for the payments embedded component.
- components.
payments. enabledbooleanRequired Whether the embedded component is enabled.
- components.
payments. featuresobject The list of features enabled in the embedded component.
- components.
payments. features. capture_ paymentsboolean Whether to allow capturing and cancelling payment intents. This is
true
by default. - components.
payments. features. destination_ on_ behalf_ of_ charge_ managementboolean Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is
false
by default. - components.
payments. features. dispute_ managementboolean Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is
true
by default. - components.
payments. features. refund_ managementboolean Whether to allow sending refunds. This is
true
by default.
- components.
payoutsobject Configuration for the payouts embedded component.
- components.
payouts. enabledbooleanRequired Whether the embedded component is enabled.
- components.
payouts. featuresobject The list of features enabled in the embedded component.
- components.
payouts. features. disable_ stripe_ user_ authenticationboolean Disables Stripe user authentication for this embedded component. This value can only be true for accounts where
controller.
isrequirement_ collection application
. The default value is the opposite of theexternal_
value. For example, if you don’t setaccount_ collection external_
, it defaults to true andaccount_ collection disable_
defaults to false.stripe_ user_ authentication - components.
payouts. features. edit_ payout_ scheduleboolean Whether to allow payout schedule to be changed. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise. - components.
payouts. features. external_ account_ collectionboolean Whether to allow platforms to control bank account collection for their connected accounts. 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. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is
true
. - components.
payouts. features. instant_ payoutsboolean Whether to allow creation of instant payouts. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise. - components.
payouts. features. standard_ payoutsboolean Whether to allow creation of standard payouts. Default
true
when Stripe owns Loss Liability, defaultfalse
otherwise.
- components.
payouts_ listobject Configuration for the payouts list embedded component.
- components.
payouts_list. enabledbooleanRequired Whether the embedded component is enabled.
- components.
payouts_list. featuresobject The list of features enabled in the embedded component.
- components.
tax_ registrationsobject Configuration for the tax registrations embedded component.
- components.
tax_registrations. enabledbooleanRequired Whether the embedded component is enabled.
- components.
tax_registrations. featuresobject The list of features enabled in the embedded component.
- components.
tax_ settingsobject Configuration for the tax settings embedded component.
- components.
tax_settings. enabledbooleanRequired Whether the embedded component is enabled.
- components.
tax_settings. featuresobject The list of features enabled in the embedded component.
Returns
Returns an Account Session object if the call succeeded.
{ "object": "account_session", "account": "acct_1NkDjjJyhOZfPCWt", "client_secret": "_OXIKXxEihJokDBnDoe2sgG5OGSO2Q12shKvbeboxpALZGng", "expires_at": 1693261123, "livemode": false, "components": { "account_management": { "enabled": false, "features": { "external_account_collection": true, "disable_stripe_user_authentication": false } }, "account_onboarding": { "enabled": true, "features": { "external_account_collection": true, "disable_stripe_user_authentication": false } }, "balances": { "enabled": true, "features": { "edit_payout_schedule": false, "instant_payouts": false, "standard_payouts": false, "external_account_collection": true, "disable_stripe_user_authentication": false } }, "documents": { "enabled": false, "features": {} }, "financial_account": { "enabled": false, "features": { "disable_stripe_user_authentication": false, "external_account_collection": false, "money_movement": false, "send_money": false, "transfer_balance": false } }, "financial_account_transactions": { "enabled": false, "features": { "card_spend_dispute_management": false } }, "issuing_card": { "enabled": false, "features": { "card_management": false, "card_spend_dispute_management": false, "cardholder_management": false, "spend_control_management": false } }, "issuing_cards_list": { "enabled": false, "features": { "card_management": false, "card_spend_dispute_management": false, "cardholder_management": false, "disable_stripe_user_authentication": false, "spend_control_management": false } }, "notification_banner": { "enabled": false, "features": { "external_account_collection": true, "disable_stripe_user_authentication": false } }, "payment_details": { "enabled": false, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": false, "dispute_management": true, "refund_management": true } }, "payments": { "enabled": true, "features": { "capture_payments": true, "destination_on_behalf_of_charge_management": false, "dispute_management": true, "refund_management": true } }, "payouts": { "enabled": true, "features": { "edit_payout_schedule": false, "instant_payouts": false, "standard_payouts": false, "external_account_collection": true, "disable_stripe_user_authentication": false } }, "payouts_list": { "enabled": false, "features": {} }, "tax_registrations": { "enabled": false, "features": {} }, "tax_settings": { "enabled": false, "features": {} } }}