.do
ApiFinance

ConnectedAccount

A connected account represents a Stripe account connected to your platform via Stripe Connect.

ConnectedAccount

A connected account represents a Stripe account connected to your platform via Stripe Connect.

Properties

  • id (string): Unique identifier for the connected account.
  • object (string): String representing the object's type (always "account").
  • businessProfile (object): Business information about the account.
  • businessType (string): Type of business (individual, company, non_profit, government_entity).
  • capabilities (object): Hash containing account capabilities and their status.
  • charges_enabled (boolean): Whether the account can create live charges.
  • company (object): Information about the company (for company accounts).
  • controller (object): Controller information for the account.
  • country (string): Two-letter country code for the account.
  • created (number): Time at which the object was created (Unix timestamp).
  • defaultCurrency (string): Three-letter ISO default currency code.
  • detailsSubmitted (boolean): Whether account details have been submitted.
  • email ([[EmailAddress]]): Email address of the account owner.
  • externalAccounts (object): External accounts (bank accounts and cards) for payouts.
  • futureRequirements (object): Information about future requirements for the account.
  • individual (object): Information about the person (for individual accounts).
  • metadata (object): Set of key-value pairs for storing additional information.
  • payoutsEnabled (boolean): Whether Stripe can send payouts to this account.
  • requirements (object): Information about current requirements for the account.
  • settings (object): Account options for customizing features.
  • tosAcceptance (object): Details on acceptance of the Stripe terms of service.
  • type (string): Account type (standard, express, custom).

Actions

create

Create a new connected account.

Input: [[ConnectedAccount]]
Output: [[ConnectedAccount]]

retrieve

Retrieve the details of a connected account.

Input: [[ConnectedAccount]]
Output: [[ConnectedAccount]]

update

Update properties of a connected account.

Input: [[ConnectedAccount]]
Output: [[ConnectedAccount]]

delete

Delete a connected account.

Input: [[ConnectedAccount]]
Output: [[ConnectedAccount]]

reject

Reject a connected account.

Input: [[ConnectedAccount]]
Output: [[ConnectedAccount]]

list

Return a list of connected accounts.

Input: [[ListRequest]]
Output: [[ConnectedAccountList]]

Events

  • created: Triggered when a connected account is created.
  • updated: Triggered when a connected account is updated.
  • externalAccountCreated: Triggered when an external account is created.
  • externalAccountDeleted: Triggered when an external account is deleted.
  • externalAccountUpdated: Triggered when an external account is updated.