v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Retrieve accounts for a client

Returns a paginated list of accounts for the specified client.

get/v1/clients/{clientId}/accounts

Path parameters

clientIdstring required

Unique identifier of the client

Response

Successful response with account details

currentPageinteger
perPageinteger
totalIteminteger

Example response

{
  "currentPage": 1,
  "perPage": 50,
  "totalItem": 1,
  "data": [
    {
      "id": "24a726ac-180d-48df-82bc-711f2788a46f",
      "bankId": "9d84b03a-28d1-4898-a69c-38824239e2b1",
      "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "clientBankAdapterId": "5b3a1b67-ab59-4cc1-8fc6-1d558b32b237",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "instrumentId": "709448c3-7cbf-454d-a87e-feb23801269a",
      "ownerId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "ownerType": "CLIENT",
      "accountNumber": "000001000004",
      "clabeNumber": "734180000001000004",
      "availableBalance": "0.00",
      "accountType": "CENTRALIZING_ACCOUNT",
      "accountStatus": "ACTIVE",
      "audit": {
        "createdAt": "2025-03-05 11:00:56.264527-06:00",
        "updatedAt": "2025-03-05 11:00:56.264527-06:00",
        "deletedAt": "None",
        "blockedAt": "None",
        "activatedAt": "None",
        "suspendedAt": "None"
      },
      "bankAdapter": "SIES"
    }
  ]
}