Sign in

v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Register an instrument for a client

Registers an instrument owned by the specified client or by one of its customers. The request body must include either debit_card or virtual_clabe..

post/v1/clients/{clientId}/instruments

Path parameters

clientIdstring required

Client identifier (UUID) under which the instrument is being registered. The actual owner will be: - The client itself, if customer_id is omitted in the request body. - The customer specified in customer_id, if provided.

Request body

OR

Example request

{
  "source_bank_id": "9d84b03a-28d1-4898-a69c-38824239e2b1",
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "customer_id": "bb1e8fde-e68e-48e9-a483-d32153c752c2",
  "type": "RECEIVER",
  "rfc": "XAXX010101000",
  "alias": "lorem-ipsum",
  "debit_card": {
    "destination_bank_id": "3054ff18-32a0-478d-b9fe-b5261f9a6e1f",
    "card_number": "5579072268574100",
    "holder_name": "John Smith"
  }
}

Response

Instrument created

idstring required
bankIdstring required
clientIdstring required
ownerIdstring 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
type'RECEIVER' required
rfcstring required
customerIdstring

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