The Authorization object 

Financial Connections
Authorization
The Authorization object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

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

  • account_holdernullable objectPreview feature

    The account holder that this authorization belongs to.

    • account_holder.accountnullable stringExpandable

      The ID of the Stripe account that this account belongs to. Only available when account_holder.type is account.

    • account_holder.customernullable stringExpandable

      The ID for an Account representing a customer that this account belongs to. Only available when account_holder.type is customer.

    • account_holder.typeenum

      Type of account holder that this account belongs to.

      Possible enum values
      account

      Account holder is a Stripe account object.

      customer

      Account holder is a Stripe customer object.

  • institution_namestring

    The name of the institution that this authorization belongs to.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • statusenum

    The status of the connection to the Authorization.

    Possible enum values
    active

    Stripe is able to retrieve data from the Authorization without issues.

    disconnected

    The Authorization is permanently disconnected and cannot be used to retrieve data.

    inactive

    Stripe cannot retrieve data from the Authorization.

  • status_detailsobject

    Details on the status of this Authorization.

    • status_details.inactivenullable object

      Details related to the inactive status of this Authorization.

      • status_details.inactive.actionenum

        The action (if any) to relink the inactive Authorization.

        Possible enum values
        none

        There is no action recommended at this time to resolve the inactive Authorization.

        relink_required

        You may relink the inactive Authorization by having your end user complete the streamlined relink flow.

The Authorization object
{
"id": "fcauth_1NSlnc2eZvKYlo2CoamIONix",
"object": "financial_connections.authorization",
"institution_name": "StripeBank",
"livemode": false,
"status": "active",
"status_details": {}
}