v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

List instruments for a client

Returns a paginated list of instruments belonging to the specified client and its customers.

Without customer_id, it returns instruments for the client and all associated customers.
With customer_id, it returns only instruments for that customer.

get/v1/clients/{clientId}/instruments

Path parameters

clientIdstring uuid required

Client identifier (UUID).

Query parameters

customer_idstring uuid

Optional customer UUID. When provided, filters instruments for this customer only.

pageinteger

Page number (1-based).

per_pageinteger

Number of items per page.

Response

List of instruments for the client (and optionally a specific customer).

currentPageinteger required

perPageinteger required

totalItemsinteger required

Example response

{
  "data": [
    {
      "id": "dd7f8d89-94dd-43ca-871b-720fde378b52",
      "bankId": "d3435bd9-998d-4e8a-9067-6b71d5fd3ac7",
      "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "ownerId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "alias": "Instrumento base",
      "type": "RECEIVER",
      "audit": {
        "createdAt": "2025-05-19 19:03:51.084659-06:00",
        "updatedAt": "2025-05-19 19:03:51.084668-06:00"
      },
      "rfc": "XAXX010101000",
      "customerId": "bb1e8fde-e68e-48e9-a483-d32153c752c2",
      "instrumentDetail": {
        "cardNumber": "5579072268574100",
        "expirationDate": "None",
        "holderName": "John Smith"
      }
    }
  ],
  "currentPage": 1,
  "perPage": 50,
  "totalItems": 17
}