conomy_hq
  1. Accounts
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
      • Get Identity
      • Update Identity
      • Delete Identity
      • Get Identities List
      • Add Child to Identity Children
      • Remove Child from Children
      • Add Rule to Identity
      • Remove Rule to Identity
    • Accounts
      • Create Account
        POST
      • Get Account
        GET
      • Update Account
        PATCH
      • Delete Account
        DELETE
      • Get multiple accounts
        GET
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
      • Authorize Payment
      • Capture Payment
      • Get Payment List
      • Get Payment List paginated
      • Get Payment
      • Receive Payment Provider Notification
      • Client Transaction's Notification Webhook
  1. Accounts

Get multiple accounts

Developing
GET
/accounts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/accounts?parentId&limit&next' \
--header 'x-api-key;' \
--header 'User-Agent;'
Response Response Example
{
  "data": [
    {
      "id": "string",
      "identityId": "string",
      "externalId": "string",
      "type": "string",
      "custody": "string",
      "balance": "string",
      "availableFunds": "string",
      "currency": "string",
      "name": "string",
      "accountNumber": "string",
      "accountHolder": "string",
      "status": "string",
      "parentId": "string",
      "subAccounts": {
        "balance": "string",
        "availableFunds": "string"
      },
      "custodyBankAccount": {
        "accountNumber": "string",
        "bank": "string",
        "currency": "string",
        "typeAccount": "string",
        "country": "string"
      }
    }
  ],
  "pagination": {
    "pagination": {
      "count": 0,
      "next": 0,
      "previous": 0,
      "total": 0
    },
    "results": [
      {}
    ]
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
parentId
string 
optional
account id
limit
string 
optional
Specifies the maximum number of items to return in a single request.
next
string 
optional
A cursor indicating the position of the last retrieved item.
Header Params
x-api-key
string 
optional
User-Agent
string 
optional

Responses

🟢200Success
application/json
Body
data
array[object (account) {15}] 
required
An array containing the list of retrieved account based on the provided pagination parameters.
id
string 
required
Unique identifier for the internal account.
identityId
string 
required
Identifier linking the internal account to an organization or user.
externalId
string 
required
External reference identifier for integrations.
type
string 
required
The type of internal account (e.g., CHECKING, ASSET, SAVINGS).
custody
string 
required
Indicates the custody provider managing the internal account.
balance
string 
required
Total balance available in the internal account.
Match pattern:
^\d+(\.\d+)?$
availableFunds
string 
required
Amount of funds available for transactions.
Match pattern:
^\d+(\.\d+)?$
currency
string 
required
The currency in which the internal account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
name
string 
required
A friendly name assigned to the internal account.
accountNumber
string 
required
Internal reference number for the account.
accountHolder
string 
required
Name of the entity or user owning the internal account.
status
string 
required
The current status of the account (e.g., PENDING, ACTIVE, BLOCKED).
parentId
string 
required
Identifier of the parent account if this is a sub-account.
subAccounts
object 
optional
Details of sub-accounts associated with this internal account.
custodyBankAccount
object 
optional
Details of the custody bank account linked to this internal account.
pagination
object (Pagination) 
required
An object containing pagination metadata that helps navigate through the dataset.
pagination
object (Pagination cursor) 
required
Pagination cursor object
results
array [object] 
required
Items from the current page
Modified at 2025-02-01 19:44:10
Previous
Delete Account
Next
Get payment-origins
Built with