Accounts

Accounts represent financial containers used to hold and manage funds.

Each account can store balances, receive or send funds, and be associated with a specific user or organization. Accounts can be created, updated, and deleted via the API, and are identified by a unique ID.

Use the Accounts API to list all accounts, create new ones, retrieve details of a specific account, update metadata, or delete an account when it’s no longer needed.

Endpoints

GET /accounts
POST /accounts
GET /accounts/:id
PATCH /accounts/:id
DELETE /accounts/:id

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"
  }
}

Get multiple accounts

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

parentIdstringOptional

Parent's account Id

accountNumberstringOptional

Account number of the specific account

externalIdstringOptional

External Id of the specific account

identityIdstringOptional

Identity Id owner of the account

typestring · enumOptional

The type of internal account.

Possible values:

currencystringOptional

Country of operations for the entity, specified using the ISO 3166-1 alpha-3 standard (e.g., CHL, USA, MEX). Go to the countries page for the complete list of supported values.

statusstringOptional

Status of the account

startDatestringOptional

Created at start (DD/MM/YYYY)

endDatestringOptional

Created at end (DD/MM/YYYY)

limitintegerOptional

Specifies the maximum number of items to return in a single request.

nextintegerOptional

A cursor indicating the position of the last retrieved item.

offsetintegerOptional

A cursor indicating how many items to skip from the request

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses

200Success

application/json

400Error

application/json

500Error

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "pagination": {
    "pagination": {
      "count": 1,
      "next": 1,
      "previous": 1,
      "total": 1
    },
    "results": [
      {
        "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"
        }
      }
    ]
  }
}

Create Account

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp/2.1.1

Body

application/json

identityIdstringRequired

Identifier linking the internal account to an organization or user.

externalIdstringOptional

External reference identifier for integrations.

typestring · enumRequired

The type of internal account.

Possible values:

custodystringRequired

Indicates the custody type managing the internal account.

currencystringRequired

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

namestringRequired

A friendly name assigned to the internal account.

parentIdstringOptional

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

Responses

201Success

application/json

400Error

application/json

500Error

application/json

post

/accounts

HTTPcURLJavaScriptPython

POST /accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "identityId": "069b63ba-a8cd-4b0e-bb2f-ffc7d71f2dac",
  "externalId": "1",
  "type": "real",
  "currency": "PKR",
  "name": "Auto Loan Account",
  "parentId": "a3f87719-1dd7-46c7-9953-e0f3a71542a3"
}

{
  "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"
  }
}

Get Account

get

Endpoint to get the accounts by a certain filter, could be the id, identityId, accountNumber.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

200Success

application/json

400Error

application/json

500Error

application/json

get

/accounts/{id}

HTTPcURLJavaScriptPython

GET /accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{
  "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"
  }
}

Update Account

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Body

application/json

externalIdstringOptional

namestringOptional

Responses

200Success

application/json

400Error

application/json

500Error

application/json

patch

/accounts/{id}

HTTPcURLJavaScriptPython

PATCH /accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "status": "BLOCKED"
}

{
  "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"
  }
}

Delete Account

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Unique identifier for the account.

Header parameters

x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Example: ConomyApp

Responses

204Success

application/json

400Error

application/json

500Error

application/json

delete

/accounts/{id}

HTTPcURLJavaScriptPython

DELETE /accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

{}