Instruments

Retrieve a single instrument

Changed on Sep 26, 2026

Retrieves an instrument for the specified client. The instrument must belong to the client or to one of its customers; otherwise an error is returned.

get/v1/clients/{clientId}/instruments/{instrumentId}

Request

Base URL
https://apicore.stg.finch.lat
Auth
HTTP bearer
TypeScript
https://skmtc.dev/monato/apis/fincore-api/docs/v1/clients/:clientId/instruments/:instrumentId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

clientIdstring uuid required

Client identifier (UUID).

instrumentIdstring uuid required

Instrument identifier (UUID).

Response

Instrument details.

idstring uuid required

Instrument UUID.

bankIdstring uuid required

Destination bank UUID associated with the instrument.

clientIdstring uuid required

Client UUID associated with the instrument.

ownerIdstring uuid required

Identifier of the entity that owns this instrument (client or customer). When the instrument belongs to a customer, ownerId and customerId will be the same.

aliasstring required

Human-friendly label for the instrument.

type'RECEIVER' | 'SENDER_RECEIVER' required

rfcstring required

RFC associated with the instrument holder.

customerIdstring uuid

Customer who owns the instrument when applicable. Present when the instrument belongs to a customer; omitted for client-level instruments.

Example response

{
  "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",
    "holderName": "John Smith"
  }
}

Changes

Sep 26, 2026e22ef66945df Revision changes
- warning
  added the new SENDER_RECEIVER enum value to the //// response property for the response status
- info
  api tag Instruments added
- info
  added the media type application/json for the response with the status
- 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

Operation history