Respuestas y Errores

Códigos HTTP, paginación, formato de errores, catálogos de errores por módulo y entidades principales del sistema.

Interpreta las respuestas de la API identificando códigos HTTP, paginación, formatos de error, catálogos por módulo y entidades principales del sistema.

Contenido de esta sección

Códigos de respuesta

Ver códigos HTTP soportados
CódigoTipoDescripción
200ÉxitoLa solicitud se procesó correctamente y devuelve los datos solicitados
201ÉxitoEl recurso fue creado exitosamente. Suele incluir el identificador del nuevo recurso
204ÉxitoLa operación se completó correctamente, pero no hay contenido que devolver
207Éxito parcialAlgunos elementos se procesaron correctamente y otros generaron observaciones o errores
400Error del clienteLa solicitud contiene datos inválidos o está mal formada. Revisa los parámetros o el body
401No autorizadoEl token de autenticación falta, está vencido o es inválido. Autentícate nuevamente
403ProhibidoEl usuario está autenticado pero no tiene permisos suficientes para este recurso
404No encontradoEl recurso solicitado no existe o no está disponible en el sistema
409ConflictoLa operación entra en conflicto con el estado actual del recurso (ej. registro duplicado)
500Error internoFalla inesperada en el servidor. Intenta nuevamente más tarde o contacta soporte
503Servicio no disponibleEl servidor o un servicio dependiente no está disponible temporalmente

Resultado esperado: podrás interpretar si una solicitud fue procesada correctamente o identificar la categoría general del error recibido.


Paginación

Los endpoints GET que devuelven múltiples resultados incluyen paginación. La respuesta incluye la cabecera X-Pagination:

{
  "TotalCount": 1403,
  "PageSize": 10,
  "CurrentPage": 1,
  "TotalPages": 141,
  "HasNext": true,
  "HasPrevious": false
}

Parámetros de paginación:

ParámetroDescripción
pageNumberNúmero de página (desde 1)
pageSizeCantidad de resultados por página (máximo 100)
💡

Usa siempre paginación en endpoints que lo permitan. El pageSize máximo es 100 registros por página.

Resultado esperado: podrás recorrer colecciones paginadas interpretando correctamente el encabezado X-Pagination.


Formato de errores

La API utiliza el formato estándar RFC 7807 (ProblemDetails) para las respuestas de error:

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "El token de acceso no es válido."
}

Para operaciones de negocio (aportes, retiros, órdenes), los errores incluyen un código específico:

[
  {
    "aporteRetiroObservacion": {
      "id": -1,
      "codTipoMovimiento": "APO_PAT",
      "numCuenta": "XXXXXXX/X",
      "uuid": "123-123-123"
    },
    "resultado": [
      {
        "tipoAlert": "error",
        "observacion": "Error al generar Movimiento",
        "error": {
          "code": "ARP-001",
          "description": "No se encontro la cuenta XXXXXXX/X"
        }
      }
    ]
  }
]

Resultado esperado: podrás distinguir entre errores técnicos estándar y errores de negocio con códigos específicos por operación.


Catálogos de errores por módulo

💡

Utiliza estos catálogos para mapear errores funcionales y definir respuestas de negocio más precisas en tu integración.

Aportes y Retiros (ARP)
CódigoDescripción
ARP-001No se encontró la cuenta {numCuenta}
ARP-002Falta ingresar NumeroCuenta de Banco
ARP-003No se encontró caja vigente {codMoneda} para la cuenta {numCuenta}
ARP-004Tipo Origen Mov Caja {codTipoMovimiento} no existe
ARP-005Falta ingresar TipoCuenta de Banco
ARP-006Falta ingresar banco
ARP-007Fecha Movimiento o Fecha Liquidacion NO es igual a la fecha actual
ARP-008Cuando CodMoneda es CLP el valor del Monto no puede contener decimales
ARP-009La fecha operación debe ser igual a la fecha máxima de las operaciones ingresadas
ARP-010Monto Máximo Permitido para RET_PAT_BA 7.000.000
ARP-011Saldo disponible insuficiente para ejecutar este movimiento
ARP-012UUID duplicado en la misma transacción
ARP-013UUID ya utilizado con anterioridad en otro movimiento de caja
ARP-014La hora actual fuera de horario permitido
ARP-015Excepción del sistema
Cuenta Remunerada (OCR)
CódigoDescripción
OCR-001No existe cuenta disponible con el número {NumCuenta}
OCR-002No se pudo obtener el precio para la operación
OCR-003No existe operación concepto
OCR-004No existe instrumento con nemotécnico
OCR-005No se encontró caja vigente {monedaTransaccion} para {NumCuenta}
OCR-006El UUID ya ha sido procesado previamente
OCR-007Error en la operación
Operaciones Spot (SPT)
CódigoDescripción
SPT-001No existe cuenta disponible con el número {numCuenta}
SPT-002No se encontró caja vigente {CodMonedaOperacion} para la cuenta {numCuenta}
SPT-003No existe caja vigente {CodMonedaPagoCobro} para la cuenta {numCuenta}
SPT-004No se encuentra tipo de operación {CodTipoOperacion} para Spot
SPT-005No existe instrumento con nemotécnico {CodMonedaOperacion}
SPT-006No existe la contraparte {Contraparte}
SPT-007Tipo Origen Mov Caja Operación no encontrado
SPT-008Tipo Origen Mov Caja Pago Cobro no se encuentra
SPT-009La fecha operación debe ser igual a la fecha máxima de operaciones ingresadas
SPT-010El monto ingresado no corresponde a (P×Q)
SPT-011Saldo disponible insuficiente para ejecutar esta operación
SPT-012UUID duplicado en la misma transacción
SPT-013UUID ya utilizado en operación anterior
SPT-014Error del sistema
SPT-015Excepción del sistema
Validación KYC
CódigoInformationDescripción
002AML High RiskCliente de riesgo alto en listas de vigilancia
003Cannot get document dataNo se puede extraer la información del documento de identidad
004Missing dataFalta información del cliente (RUT, codDocumento, etc.)
005Document rejectedDocumento rechazado por proveedor
006Code not foundNo se encuentra codIdentificación

Entidades principales

Ver entidades principales del sistema
EntidadDescripción
ClientePersona natural o jurídica. Usuario final según normativa CMF
CuentaCuenta de inversión en una divisa, vinculada a un asesor o fintech
AsesorCanal o motor de inversión (la fintech que se integra con Voultech)
CarteraPortafolio de instrumentos del cliente con valorización actualizada
CajaFondos disponibles por cuenta y divisa
MovimientoFlujo de dinero registrado en una caja
OperaciónMovimiento asociado a nemotécnicos que componen la cartera
OrdenInstrucción de compra o venta de instrumentos financieros
AsignaciónDetalle de ejecución y distribución de órdenes en el mercado
MovimientosShinkansenRetiros vía Banco Online
MovimientosBancoSecurityConsulta de movimientos desde Banco Security
MovimientosBancoBiceConsulta de movimientos desde Banco Bice

Resultado esperado: dispondrás de una referencia rápida para interpretar las entidades principales mencionadas en la API.