Convenciones

Reglas que aplican a todos los endpoints. Leélas antes de la referencia de cada recurso.

Autenticación

Todos los endpoints requieren firma HMAC y los headers x-signature-key, x-signature-value, x-signature-timestamp y x-idempotency. Ver Autenticación.

Respuestas asíncronas

Muchas operaciones de escritura se procesan de forma asíncrona. En ese caso la API responde con un envelope de operación y el resultado final llega por WebSocket:

{
  "operationId": "9c1f2a3b-...",
  "status": "pending",
  "message": "processing",
  "owner": "3f9a1c2e-...",
  "ttl": 300
}

Campo	Tipo	Descripción
operationId	string	Id de la operación. Usalo para seguirla (movimientos, notificaciones).
status	string	Estado inicial (ver estados abajo).
message	string	Mensaje legible.
owner	string (uuid)	Identificador para suscribirte a la notificación por WebSocket. Opcional en algunas respuestas.
ttl	number	Segundos de validez del owner. Opcional en algunas respuestas.

Algunos endpoints devuelven 202 cuando la respuesta es asíncrona (CVU) y 200 cuando es sincrónica. Las respuestas sincrónicas devuelven directamente el recurso (ver cada endpoint).

Estados de una operación

ready, working, pending, fulfilled, failed, dead, queued, outside, rejected, manual

fulfilled = completada con éxito. failed / dead / rejected = terminó sin éxito.

Paginación

Los listados aceptan page (default 1) y limit (default 10, máximo 100) como query params y devuelven:

{
  "data": [ /* items */ ],
  "pagination": { "page": 1, "limit": 10, "total": 42, "totalPages": 5, "hasNext": true, "hasPrev": false }
}

info

En GET /api/v1/movement, limit: 0 devuelve todos los movimientos (sin paginar).

Formato de respuesta y errores

Respuesta exitosa: el body contiene directamente los datos del recurso o el envelope de operación. Los errores usan códigos HTTP estándar; el detalle está en Códigos de error.

Tipos comunes

Tipo	Descripción
AccountIdentifier	Identifica una cuenta. Puede ser: UUID, Alias (6–20 caracteres [A-Za-z0-9._-]), CBU (22 dígitos, no empieza en 000) o CVU (22 dígitos, empieza en 000). Se usa en from, to, identifier.
amount	Monto como string decimal, positivo y distinto de cero. Ej: "2500.00".
TransferConcept	Concepto de la transferencia (enum). Ver Transferencias.
fiscal	Condición fiscal: RI (Responsable inscripto), MO (Monotributo), CF (Consumidor final), EX (Exento), NC (No categorizado). Ver Clientes.
tax_number	CUIT/CUIL: 11 dígitos con checksum válido.
currency_id	Moneda: ARS, USD, EUR.