Accounts

Retrieve accounts for a client

Changed on

Returns a paginated list of accounts for the client. The Centralizing Account is identified by accountType = CENTRALIZING_ACCOUNT; private accounts are identified by accountType = PRIVATE_ACCOUNT.

get/v1/clients/{clientId}/accounts

Request

Path parameters

clientIdstring required

Unique identifier of the client

Response

Successful response with account details

currentPageinteger required

Current page number.

perPageinteger required

Number of accounts returned per page.

totalIteminteger required

Total number of accounts matching the request.

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": "PRIVATE_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"
      },
      "bankAdapter": "SIES"
    }
  ]
}

Changes

    • warning

      added the new BLOCKED enum value to the // response property for the response status

    • warning

      added the new CANCELLED enum value to the // response property for the response status

    • warning

      added the new CHECKING_ACCOUNT enum value to the // response property for the response status

    • warning

      added the new DISPERSION_ACCOUNT enum value to the // response property for the response status

    • warning

      added the new PRIVATE_ACCOUNT enum value to the // response property for the response status

    • warning

      added the new SAVINGS_ACCOUNT enum value to the // response property for the response status

    • info

      api tag Accounts added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the INACTIVE enum value from the // response property for the response status

    • info

      removed the OTHER enum value from the // response property for the response status