Create a Session

Changed on

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

post/v1/link_account_sessions

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/link_account_sessions
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

expandstring[]

Specifies which fields in the response should be expanded.

permissionsstring[] required

List of data features that you would like to request access to.

Possible values are balances, transactions, ownership, and payment_method.

prefetchstring[]

List of data features that you would like to retrieve upon account creation.

return_urlstring

For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

Response

Successful response.

client_secretstring nullable

A value that will be passed to the client to launch the authentication flow.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'financial_connections.session' required

String representing the object's type. Objects of the same type share the same value.

permissionsstring[] required

Permissions requested for accounts collected during this session.

prefetchstring[] nullable

Data features requested to be retrieved upon account creation.

return_urlstring

For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

Changes

  • 585b581504aeRevision changes
    • warning

      added the new final_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the /////////////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ///////////// response property for the response status

    • warning

      added the new final_payment_failure enum value to the ////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the //////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the /////////////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ///////////// response property for the response status

    • warning

      added the new first_payment_failure enum value to the ////////// response property for the response status

  • 7537419124b6Revision changes
    • info

      added the optional property ///////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.