ACCOUNT

Platform account node. Used to reference an account held on the platform.

The ACCOUNT node references an internal account on the conomy_hq platform. It's used as an origin or destination when the funds move from or to a platform-managed account (identified by account number or identity).

Direction: Pay-in / Pay-out

Fields

Field	Type	Description
type	string	Must be "ACCOUNT"
currency	string	Currency of the account
account.accountNumber	string	Platform account number
account.identityId	string	Identity ID linked to the account

Example — as origin (payout flow)

{
  "type": "ACCOUNT",
  "currency": "CLP",
  "account": {
    "accountNumber": "acc_abc123"
  }
}

Example — as destination (top-up flow)

{
  "type": "ACCOUNT",
  "currency": "BRL",
  "account": {
    "accountNumber": "acc_xyz456",
    "identityId": "identity_789"
  }
}

The accountNumber corresponds to the account created via the Accounts API.

Schema

The account object

Attributes

Schema representing an internal account used for handling financial operations within the system.

idstringRequired

Unique identifier for the internal account.

identityIdstringRequired

Identifier linking the internal account to an organization or user.

externalIdstringRequired

External reference identifier for integrations.

typestring · enumRequired

The type of internal account.

Possible values:

custodystringRequired

Indicates the custody type managing the internal account.

balancestringRequired

Total balance available in the internal account.

Pattern: ^\d+(\.\d+)?$

availableFundsstringRequired

Amount of funds available for transactions.

Pattern: ^\d+(\.\d+)?$

currencystringRequired

The currency in which the internal account operates. Please check "currencies" page.

namestringRequired

A friendly name assigned to the internal account.

accountNumberstringRequired

Internal reference number for the account.

accountHolderstringRequired

Name of the entity or user owning the internal account.

statusstringRequired

The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).

parentIdstringRequired

Identifier of the parent account if this is a sub-account.

The account object

{
  "id": "text",
  "identityId": "text",
  "externalId": "text",
  "type": "CHECKING",
  "custody": "text",
  "balance": "text",
  "availableFunds": "text",
  "currency": "text",
  "name": "text",
  "accountNumber": "text",
  "accountHolder": "text",
  "status": "text",
  "parentId": "text",
  "subAccounts": {
    "balance": "text",
    "availableFunds": "text"
  },
  "custodyBankAccount": {
    "accountNumber": "text",
    "bank": "text",
    "currency": "text",
    "typeAccount": "text",
    "country": "text"
  }
}