Create an Account Session

Connect

Account Session

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
  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.
  components.account_management.features.external_account_collectionboolean
  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_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
  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.
  components.account_onboarding.features.external_account_collectionboolean
  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.balance_reportobject
  Configuration for the balance report embedded component.
  components.balance_report.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.balance_report.featuresobject
  An empty list, because this embedded component has no features.
- 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
  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.
  components.balances.features.edit_payout_scheduleboolean
  Whether to allow payout schedule to be changed. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
  components.balances.features.external_account_collectionboolean
  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.features.instant_payoutsboolean
  Whether to allow creation of instant payouts. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
  components.balances.features.standard_payoutsboolean
  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_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 connected accounts can manage destination charges that are created on behalf of them. This is false by default.
  components.disputes_list.features.dispute_managementboolean
  Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
  components.disputes_list.features.refund_managementboolean
  Whether sending refunds is enabled. 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
  An empty list, because this embedded component has no features.
- 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
  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.
  components.financial_account.features.external_account_collectionboolean
  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.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.instant_payouts_promotionobject
  Configuration for the instant payouts promotion embedded component.
  components.instant_payouts_promotion.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.instant_payouts_promotion.featuresobject
  The list of features enabled in the embedded component.
  components.instant_payouts_promotion.features.disable_stripe_user_authenticationboolean
  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.
  components.instant_payouts_promotion.features.external_account_collectionboolean
  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.instant_payouts_promotion.features.instant_payoutsboolean
  Whether to allow creation of instant payouts. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
- 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
  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.
  components.issuing_cards_list.features.spend_control_managementboolean
  Whether to allow spend control management features.
- components.notification_bannerobject
  Configuration for the notification banner embedded component.
  components.notification_banner.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.notification_banner.featuresobject
  The list of features enabled in the embedded component.
  components.notification_banner.features.disable_stripe_user_authenticationboolean
  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.
  components.notification_banner.features.external_account_collectionboolean
  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_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 connected accounts can manage destination charges that are created on behalf of them. This is false by default.
  components.payment_details.features.dispute_managementboolean
  Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
  components.payment_details.features.refund_managementboolean
  Whether sending refunds is enabled. 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 connected accounts can manage destination charges that are created on behalf of them. This is false by default.
  components.payment_disputes.features.dispute_managementboolean
  Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
  components.payment_disputes.features.refund_managementboolean
  Whether sending refunds is enabled. 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 connected accounts can manage destination charges that are created on behalf of them. This is false by default.
  components.payments.features.dispute_managementboolean
  Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is true by default.
  components.payments.features.refund_managementboolean
  Whether sending refunds is enabled. This is true by default.
- components.payout_detailsobject
  Configuration for the payout details embedded component.
  components.payout_details.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.payout_details.featuresobject
  An empty list, because this embedded component has no features.
- components.payout_reconciliation_reportobject
  Configuration for the payout reconciliation report embedded component.
  components.payout_reconciliation_report.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.payout_reconciliation_report.featuresobject
  An empty list, because this embedded component has no features.
- 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
  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.
  components.payouts.features.edit_payout_scheduleboolean
  Whether to allow payout schedule to be changed. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
  components.payouts.features.external_account_collectionboolean
  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.payouts.features.instant_payoutsboolean
  Whether to allow creation of instant payouts. Defaults to true when controller.losses.payments is set to stripe for the account, otherwise false.
  components.payouts.features.standard_payoutsboolean
  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_listobject
  Configuration for the payouts list embedded component.
  components.payouts_list.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.payouts_list.featuresobject
  An empty list, because this embedded component has no features.
- components.tax_registrationsobject
  Configuration for the tax registrations embedded component.
  components.tax_registrations.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.tax_registrations.featuresobject
  An empty list, because this embedded component has no features.
- components.tax_settingsobject
  Configuration for the tax settings embedded component.
  components.tax_settings.enabledbooleanRequired
  Whether the embedded component is enabled.
  components.tax_settings.featuresobject
  An empty list, because this embedded component has no features.

Returns

Returns an Account Session object if the call succeeded.

POST /v1/account_sessions

Server-side language

curl https://api.stripe.com/v1/account_sessions \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d account=acct_1NkDjjJyhOZfPCWt \
  -d "components[account_onboarding][enabled]"=true \
  -d "components[payments][enabled]"=true \
  -d "components[payouts][enabled]"=true \
  -d "components[balances][enabled]"=true

Response

{
  "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": {}
    }
  }
}

Create an Account Session

Parameters

accountstringRequired

componentsobjectRequired

components.account_managementobject

components.account_management.enabledbooleanRequired

components.account_management.featuresobject

components.account_management.features.disable_stripe_user_authenticationboolean

components.account_management.features.external_account_collectionboolean

components.account_onboardingobject

components.account_onboarding.enabledbooleanRequired

components.account_onboarding.featuresobject

components.account_onboarding.features.disable_stripe_user_authenticationboolean

components.account_onboarding.features.external_account_collectionboolean

components.balance_reportobject

components.balance_report.enabledbooleanRequired

components.balance_report.featuresobject

components.balancesobject

components.balances.enabledbooleanRequired

components.balances.featuresobject

components.balances.features.disable_stripe_user_authenticationboolean

components.balances.features.edit_payout_scheduleboolean

components.balances.features.external_account_collectionboolean

components.balances.features.instant_payoutsboolean

components.balances.features.standard_payoutsboolean

components.disputes_listobject

components.disputes_list.enabledbooleanRequired

components.disputes_list.featuresobject

components.disputes_list.features.capture_paymentsboolean

components.disputes_list.features.destination_on_behalf_of_charge_managementboolean

components.disputes_list.features.dispute_managementboolean

components.disputes_list.features.refund_managementboolean

components.documentsobject

components.documents.enabledbooleanRequired

components.documents.featuresobject

components.financial_accountobject

components.financial_account.enabledbooleanRequired

components.financial_account.featuresobject

components.financial_account.features.disable_stripe_user_authenticationboolean

components.financial_account.features.external_account_collectionboolean

components.financial_account.features.send_moneyboolean

components.financial_account.features.transfer_balanceboolean

components.financial_account_transactionsobject

components.financial_account_transactions.enabledbooleanRequired

components.financial_account_transactions.featuresobject

components.financial_account_transactions.features.card_spend_dispute_managementboolean

components.instant_payouts_promotionobject

components.instant_payouts_promotion.enabledbooleanRequired

components.instant_payouts_promotion.featuresobject

components.instant_payouts_promotion.features.disable_stripe_user_authenticationboolean

components.instant_payouts_promotion.features.external_account_collectionboolean

components.instant_payouts_promotion.features.instant_payoutsboolean

components.issuing_cardobject

components.issuing_card.enabledbooleanRequired

components.issuing_card.featuresobject

components.issuing_card.features.card_managementboolean

components.issuing_card.features.card_spend_dispute_managementboolean

components.issuing_card.features.cardholder_managementboolean

components.issuing_card.features.spend_control_managementboolean

components.issuing_cards_listobject

components.issuing_cards_list.enabledbooleanRequired

components.issuing_cards_list.featuresobject

components.issuing_cards_list.features.card_managementboolean

components.issuing_cards_list.features.card_spend_dispute_managementboolean

components.issuing_cards_list.features.cardholder_managementboolean

components.issuing_cards_list.features.disable_stripe_user_authenticationboolean

components.issuing_cards_list.features.spend_control_managementboolean

components.notification_bannerobject

components.notification_banner.enabledbooleanRequired

components.notification_banner.featuresobject

components.notification_banner.features.disable_stripe_user_authenticationboolean

components.notification_banner.features.external_account_collectionboolean

components.payment_detailsobject

components.payment_details.enabledbooleanRequired

components.payment_details.featuresobject

components.payment_details.features.capture_paymentsboolean

components.payment_details.features.destination_on_behalf_of_charge_managementboolean

components.payment_details.features.dispute_managementboolean

components.payment_details.features.refund_managementboolean

components.payment_disputesobject