Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create an Account Session 

Connect
Account Session
Create an 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.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.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.edit_payout_scheduleboolean

          Whether to allow payout schedule to be changed. Default true when Stripe owns Loss Liability, default false 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, default false otherwise.

        • components.balances.features.standard_payoutsboolean

          Whether to allow creation of standard payouts. Default true when Stripe owns Loss Liability, default false otherwise.

    • 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.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.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.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.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.edit_payout_scheduleboolean

          Whether to allow payout schedule to be changed. Default true when Stripe owns Loss Liability, default false 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, default false otherwise.

        • components.payouts.features.standard_payoutsboolean

          Whether to allow creation of standard payouts. Default true when Stripe owns Loss Liability, default false 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.

POST /v1/account_sessions
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
      }
    },
    "account_onboarding": {
      "enabled": true,
      "features": {
        "external_account_collection": true
      }
    },
    "balances": {
      "enabled": true,
      "features": {
        "edit_payout_schedule": false,
        "instant_payouts": false,
        "standard_payouts": false,
        "external_account_collection": true
      }
    },
    "documents": {
      "enabled": false,
      "features": {}
    },
    "notification_banner": {
      "enabled": false,
      "features": {
        "external_account_collection": true
      }
    },
    "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
      }
    },
    "payouts_list": {
      "enabled": false,
      "features": {}
    },
    "tax_registrations": {
      "enabled": false,
      "features": {}
    },
    "tax_settings": {
      "enabled": false,
      "features": {}
    }
  }
}