Skip to main content
A connected account (connected_account) is a merchant that currently authorizes your platform. Its ID is the merchant’s mer_… ID. You receive it from an Account Link or an account authorization, and you store it with your own merchant record. For how Connect fits together, see How Connect works. To act for a connected account, send its ID in the Ionic-Account header with your platform secret key, or use the SDK’s account option. The two read requests on this page identify merchants by ID and use your platform key without Ionic-Account. They return the accounts connected to your platform in the key’s mode.

​
Attributes

​
string
Unique identifier for the connected account (mer_…).
​
string
The connected account’s business name.
​
string
Status of the connected account itself: pending, active, suspended, or rejected.
​
string
Status of the connection between your platform and the connected account: pending, active, or suspended.
​
boolean
Whether the connected account can currently process payments in this key’s mode.
​
array of strings
Permissions the connected account has granted to your platform.
​
integer
Unix epoch seconds.
See every field in the response of Retrieve a connected Account.

​
Endpoints

​
Statuses

A connected account reports two status fields. The object also includes business_name, payments_enabled, permissions, livemode, and connected_at (Unix epoch seconds).

​
Rules

  • Check connection_status, account_status, payments_enabled, permissions, and livemode before offering payment features. Approval connects the merchant; it does not activate their payment capability. Access can change after approval.
  • A request for a connected account’s resources succeeds when your platform key and the merchant’s connection both grant the permission the operation needs.
  • The list uses cursor pagination. Pass next_cursor as starting_after to get the next page. The page size defaults to 50, with a maximum of 100.
  • An unknown ID, or one that is not connected to your platform in the key’s mode, returns 404.