POST /v1/account_sessions

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.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
account String Yes

The identifier of the account to create an Account Session for.

expand[] Array No

Specifies which fields in the response should be expanded.

components Object Yes

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.payment_disputes Object No
components.payment_disputes.enabled Boolean Yes
components.payment_disputes.features Object No
components.payment_disputes.features.dispute_management Boolean No
components.payment_disputes.features.destination_on_behalf_of_charge_management Boolean No
components.payment_disputes.features.refund_management Boolean No
components.financial_account_transactions Object No
components.financial_account_transactions.enabled Boolean Yes
components.financial_account_transactions.features Object No
components.financial_account_transactions.features.card_spend_dispute_management Boolean No
components.tax_registrations Object No
components.tax_registrations.enabled Boolean Yes
components.tax_registrations.features Object No
components.payments Object No
components.payments.enabled Boolean Yes
components.payments.features Object No
components.payments.features.dispute_management Boolean No
components.payments.features.destination_on_behalf_of_charge_management Boolean No
components.payments.features.refund_management Boolean No
components.payments.features.capture_payments Boolean No
components.balances Object No
components.balances.enabled Boolean Yes
components.balances.features Object No
components.balances.features.standard_payouts Boolean No
components.balances.features.external_account_collection Boolean No
components.balances.features.edit_payout_schedule Boolean No
components.balances.features.disable_stripe_user_authentication Boolean No
components.balances.features.instant_payouts Boolean No
components.account_management Object No
components.account_management.enabled Boolean Yes
components.account_management.features Object No
components.account_management.features.external_account_collection Boolean No
components.account_management.features.disable_stripe_user_authentication Boolean No
components.payouts_list Object No
components.payouts_list.enabled Boolean Yes
components.payouts_list.features Object No
components.account_onboarding Object No
components.account_onboarding.enabled Boolean Yes
components.account_onboarding.features Object No
components.account_onboarding.features.external_account_collection Boolean No
components.account_onboarding.features.disable_stripe_user_authentication Boolean No
components.documents Object No
components.documents.enabled Boolean Yes
components.documents.features Object No
components.notification_banner Object No
components.notification_banner.enabled Boolean Yes
components.notification_banner.features Object No
components.notification_banner.features.external_account_collection Boolean No
components.notification_banner.features.disable_stripe_user_authentication Boolean No
components.payment_details Object No
components.payment_details.enabled Boolean Yes
components.payment_details.features Object No
components.payment_details.features.dispute_management Boolean No
components.payment_details.features.destination_on_behalf_of_charge_management Boolean No
components.payment_details.features.refund_management Boolean No
components.payment_details.features.capture_payments Boolean No
components.tax_settings Object No
components.tax_settings.enabled Boolean Yes
components.tax_settings.features Object No
components.financial_account Object No
components.financial_account.enabled Boolean Yes
components.financial_account.features Object No
components.financial_account.features.send_money Boolean No
components.financial_account.features.external_account_collection Boolean No
components.financial_account.features.transfer_balance Boolean No
components.financial_account.features.disable_stripe_user_authentication Boolean No
components.disputes_list Object No
components.disputes_list.enabled Boolean Yes
components.disputes_list.features Object No
components.disputes_list.features.dispute_management Boolean No
components.disputes_list.features.destination_on_behalf_of_charge_management Boolean No
components.disputes_list.features.refund_management Boolean No
components.disputes_list.features.capture_payments Boolean No
components.issuing_cards_list Object No
components.issuing_cards_list.enabled Boolean Yes
components.issuing_cards_list.features Object No
components.issuing_cards_list.features.card_management Boolean No
components.issuing_cards_list.features.spend_control_management Boolean No
components.issuing_cards_list.features.cardholder_management Boolean No
components.issuing_cards_list.features.disable_stripe_user_authentication Boolean No
components.issuing_cards_list.features.card_spend_dispute_management Boolean No
components.issuing_card Object No
components.issuing_card.enabled Boolean Yes
components.issuing_card.features Object No
components.issuing_card.features.card_management Boolean No
components.issuing_card.features.spend_control_management Boolean No
components.issuing_card.features.cardholder_management Boolean No
components.issuing_card.features.card_spend_dispute_management Boolean No
components.payouts Object No
components.payouts.enabled Boolean Yes
components.payouts.features Object No
components.payouts.features.standard_payouts Boolean No
components.payouts.features.external_account_collection Boolean No
components.payouts.features.edit_payout_schedule Boolean No
components.payouts.features.disable_stripe_user_authentication Boolean No
components.payouts.features.instant_payouts Boolean No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.