The FinancialAccount object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• active_featuresarray of enums

  The array of paths to active Features in the Features hash.

• balanceobject

  The single multi-currency balance of the FinancialAccount. Positive values represent money that belongs to the user while negative values represent funds the user owes. Currently, FinancialAccounts can only carry balances in USD.

  Hide child attributes

  • balance.cashobject

    Funds the user can spend right now.

  • balance.inbound_pendingobject

    Funds not spendable yet, but will become available at a later time.

  • balance.outbound_pendingobject

    Funds in the account, but not spendable because they are being held for pending outbound flows.

• countrystring

  Two-letter country code (ISO 3166-1 alpha-2).

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• featuresnullable objectExpandable

  The features and their statuses for this FinancialAccount.

  Hide child attributes

  • features.objectstring

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

  • features.card_issuingnullable object

    Contains a Feature encoding the FinancialAccount’s ability to be used with the Issuing product, including attaching cards to and drawing funds from.

    Hide child attributes

    • features.card_issuing.requestedboolean

      Whether the FinancialAccount should have the Feature.

    • features.card_issuing.statusenum

      Whether the Feature is operational.

      Possible enum values

      active Indicates that the Feature might be used.

      pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

      restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

    • features.card_issuing.status_detailsarray of objects

      Additional details; includes at least one entry when the status is not active.

      Hide child attributes

      • features.card_issuing.status_details.codeenum

        Represents the reason why the status is pending or restricted.

        Possible enum values

        activating This Feature has met all other requirements and Stripe is in the process of making it active.

        capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

        financial_account_closed The FinancialAccount that this Feature is attached to is closed.

        rejected_other The FinancialAccount is never allowed to use this Feature.

        rejected_unsupported_business The user’s business isn’t supported by this Feature.

        requirements_past_due Onboarding requirements needed to activate this Feature.

        requirements_pending_verification Stripe is in the process of verifying the user.

        restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

        restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

      • features.card_issuing.status_details.resolutionnullable enum

        Represents what the user should do, if anything, to activate the Feature.

        Possible enum values

        contact_stripe The user should contact Stripe via support.stripe.com.

        provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

        remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

      • features.card_issuing.status_details.restrictionnullable enum

        The platform_restrictions that are restricting this Feature.

        Possible enum values

        inbound_flows Restricts all inbound money movement.

        outbound_flows Restricts all outbound money movement.

  • features.deposit_insurancenullable object

    Represents whether this FinancialAccount is eligible for deposit insurance. Various factors determine the insurance amount.

    Hide child attributes

    • features.deposit_insurance.requestedboolean

      Whether the FinancialAccount should have the Feature.

    • features.deposit_insurance.statusenum

      Whether the Feature is operational.

      Possible enum values

      active Indicates that the Feature might be used.

      pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

      restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

    • features.deposit_insurance.status_detailsarray of objects

      Additional details; includes at least one entry when the status is not active.

      Hide child attributes

      • features.deposit_insurance.status_details.codeenum

        Represents the reason why the status is pending or restricted.

        Possible enum values

        activating This Feature has met all other requirements and Stripe is in the process of making it active.

        capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

        financial_account_closed The FinancialAccount that this Feature is attached to is closed.

        rejected_other The FinancialAccount is never allowed to use this Feature.

        rejected_unsupported_business The user’s business isn’t supported by this Feature.

        requirements_past_due Onboarding requirements needed to activate this Feature.

        requirements_pending_verification Stripe is in the process of verifying the user.

        restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

        restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

      • features.deposit_insurance.status_details.resolutionnullable enum

        Represents what the user should do, if anything, to activate the Feature.

        Possible enum values

        contact_stripe The user should contact Stripe via support.stripe.com.

        provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

        remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

      • features.deposit_insurance.status_details.restrictionnullable enum

        The platform_restrictions that are restricting this Feature.

        Possible enum values

        inbound_flows Restricts all inbound money movement.

        outbound_flows Restricts all outbound money movement.

  • features.financial_addressesnullable object

    Contains Features that add FinancialAddresses to the FinancialAccount.

    Hide child attributes

    • features.financial_addresses.abanullable object

      Adds an ABA FinancialAddress to the FinancialAccount.

      Hide child attributes

      • features.financial_addresses.aba.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.financial_addresses.aba.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.financial_addresses.aba.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.financial_addresses.aba.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.financial_addresses.aba.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.financial_addresses.aba.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

  • features.inbound_transfersnullable object

    Contains settings related to adding funds to a FinancialAccount from another Account with the same owner.

    Hide child attributes

    • features.inbound_transfers.achnullable object

      Enables ACH Debits via the InboundTransfers API.

      Hide child attributes

      • features.inbound_transfers.ach.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.inbound_transfers.ach.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.inbound_transfers.ach.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.inbound_transfers.ach.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.inbound_transfers.ach.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.inbound_transfers.ach.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

  • features.intra_stripe_flowsnullable object

    Represents the ability for this FinancialAccount to send money to, or receive money from other FinancialAccounts (for example, via OutboundPayment).

    Hide child attributes

    • features.intra_stripe_flows.requestedboolean

      Whether the FinancialAccount should have the Feature.

    • features.intra_stripe_flows.statusenum

      Whether the Feature is operational.

      Possible enum values

      active Indicates that the Feature might be used.

      pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

      restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

    • features.intra_stripe_flows.status_detailsarray of objects

      Additional details; includes at least one entry when the status is not active.

      Hide child attributes

      • features.intra_stripe_flows.status_details.codeenum

        Represents the reason why the status is pending or restricted.

        Possible enum values

        activating This Feature has met all other requirements and Stripe is in the process of making it active.

        capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

        financial_account_closed The FinancialAccount that this Feature is attached to is closed.

        rejected_other The FinancialAccount is never allowed to use this Feature.

        rejected_unsupported_business The user’s business isn’t supported by this Feature.

        requirements_past_due Onboarding requirements needed to activate this Feature.

        requirements_pending_verification Stripe is in the process of verifying the user.

        restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

        restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

      • features.intra_stripe_flows.status_details.resolutionnullable enum

        Represents what the user should do, if anything, to activate the Feature.

        Possible enum values

        contact_stripe The user should contact Stripe via support.stripe.com.

        provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

        remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

      • features.intra_stripe_flows.status_details.restrictionnullable enum

        The platform_restrictions that are restricting this Feature.

        Possible enum values

        inbound_flows Restricts all inbound money movement.

        outbound_flows Restricts all outbound money movement.

  • features.outbound_paymentsnullable object

    Contains Features related to initiating money movement out of the FinancialAccount to someone else’s bucket of money.

    Hide child attributes

    • features.outbound_payments.achnullable object

      Enables ACH transfers via the OutboundPayments API.

      Hide child attributes

      • features.outbound_payments.ach.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.outbound_payments.ach.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.outbound_payments.ach.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.outbound_payments.ach.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.outbound_payments.ach.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.outbound_payments.ach.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

    • features.outbound_payments.us_domestic_wirenullable object

      Enables US domestic wire transfers via the OutboundPayments API.

      Hide child attributes

      • features.outbound_payments.us_domestic_wire.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.outbound_payments.us_domestic_wire.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.outbound_payments.us_domestic_wire.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.outbound_payments.us_domestic_wire.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.outbound_payments.us_domestic_wire.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.outbound_payments.us_domestic_wire.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

  • features.outbound_transfersnullable object

    Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner.

    Hide child attributes

    • features.outbound_transfers.achnullable object

      Enables ACH transfers via the OutboundTransfers API.

      Hide child attributes

      • features.outbound_transfers.ach.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.outbound_transfers.ach.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.outbound_transfers.ach.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.outbound_transfers.ach.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.outbound_transfers.ach.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.outbound_transfers.ach.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

    • features.outbound_transfers.us_domestic_wirenullable object

      Enables US domestic wire transfers via the OutboundTransfers API.

      Hide child attributes

      • features.outbound_transfers.us_domestic_wire.requestedboolean

        Whether the FinancialAccount should have the Feature.

      • features.outbound_transfers.us_domestic_wire.statusenum

        Whether the Feature is operational.

        Possible enum values

        active Indicates that the Feature might be used.

        pending Indicates that the Feature can’t be used but that the status eventually changes to either restricted or active without user intervention.

        restricted Indicates that the Feature can’t be used and either requires some action by the user or is permanently disabled.

      • features.outbound_transfers.us_domestic_wire.status_detailsarray of objects

        Additional details; includes at least one entry when the status is not active.

        Hide child attributes

        • features.outbound_transfers.us_domestic_wire.status_details.codeenum

          Represents the reason why the status is pending or restricted.

          Possible enum values

          activating This Feature has met all other requirements and Stripe is in the process of making it active.

          capability_not_requested The user hasn’t requested required capabilities to activate this Feature.

          financial_account_closed The FinancialAccount that this Feature is attached to is closed.

          rejected_other The FinancialAccount is never allowed to use this Feature.

          rejected_unsupported_business The user’s business isn’t supported by this Feature.

          requirements_past_due Onboarding requirements needed to activate this Feature.

          requirements_pending_verification Stripe is in the process of verifying the user.

          restricted_by_platform Some or all functionality of this Feature has been restricted by the platform via FinancialAccount platform_restritions.

          restricted_other The FinancialAccount isn’t currently allowed to use this Feature.

        • features.outbound_transfers.us_domestic_wire.status_details.resolutionnullable enum

          Represents what the user should do, if anything, to activate the Feature.

          Possible enum values

          contact_stripe The user should contact Stripe via support.stripe.com.

          provide_information The user should provide necessary onboarding requirements through /v1/accounts or the Stripe Dashboard.

          remove_restriction The user should remove the restriction on the Feature by unrestricting the FinancialAccount platform_restritions indicated by the status_details.restriction field.

        • features.outbound_transfers.us_domestic_wire.status_details.restrictionnullable enum

          The platform_restrictions that are restricting this Feature.

          Possible enum values

          inbound_flows Restricts all inbound money movement.

          outbound_flows Restricts all outbound money movement.

• financial_addressesarray of objects

  The set of credentials that resolve to a FinancialAccount.

  Hide child attributes

  • financial_addresses.abanullable object

    Identifying information for the ABA address

    Hide child attributes

    • financial_addresses.aba.account_holder_namestring

      The name of the person or business that owns the bank account.

    • financial_addresses.aba.account_numbernullable stringExpandable

      The account number.

    • financial_addresses.aba.account_number_last4string

      The last four characters of the account number.

    • financial_addresses.aba.bank_namestring

      Name of the bank.

    • financial_addresses.aba.routing_numberstring

      Routing number for the account.

  • financial_addresses.supported_networksnullable array of enums

    The list of networks that the address supports

  • financial_addresses.typeenum

    The type of financial address

• livemodeboolean

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

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• nicknamenullable stringPreview feature

  The nickname for the FinancialAccount.

• pending_featuresarray of enums

  The array of paths to pending Features in the Features hash.

• platform_restrictionsnullable object

  The set of functionalities that the platform can restrict on the FinancialAccount.

  Hide child attributes

  • platform_restrictions.inbound_flowsnullable enum

    Restricts all inbound money movement.

    Possible enum values

    restricted The functionality is restricted.

    unrestricted The functionality is not restricted.

  • platform_restrictions.outbound_flowsnullable enum

    Restricts all outbound money movement.

    Possible enum values

    restricted The functionality is restricted.

    unrestricted The functionality is not restricted.

• restricted_featuresarray of enums

  The array of paths to restricted Features in the Features hash.

• statusenum

  Status of this FinancialAccount.

  Possible enum values

  closed The FinancialAccount is closed.

  open The FinancialAccount is open.

• status_detailsobject

  Details related to the status of this FinancialAccount.

  Hide child attributes

  • status_details.closednullable object

    Details related to the closure of this FinancialAccount

    Hide child attributes

    • status_details.closed.reasonsarray of enums

      The array that contains reasons for a FinancialAccount closure.

      Possible enum values

      account_rejected The underlying account is permanently rejected.

      closed_by_platform The FinancialAccount has been closed through the API.

      other The FinancialAccount has been closed by Stripe.

• supported_currenciesarray of enums

  The currencies the FinancialAccount can hold a balance in. Three-letter ISO currency code, in lowercase.