Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS

Códigos de Respuesta - Indice Manual Integración Directa HKA Fácil RIPS

La API HKA Fácil RIPS retorna dos tipos de códigos en cada respuesta:

• Código HTTP: Código de estado estándar del protocolo HTTP.
• Código de negocio: Código específico retornado en el campo codigo del cuerpo JSON. Este código es el que determina el resultado real de la operación.

@IMPORTANTE: El código HTTP puede variar según el contexto, pero el código de negocio siempre refleja el resultado específico de la operación. Se debe verificar siempre el campo codigo del cuerpo de la respuesta para determinar el resultado correcto.

Códigos de Negocio Generales

Código	HTTP Status	estado	Aplica en	Descripción
200	200 OK	true	Enviar, Estado	Operación exitosa. El RIPS fue enviado y aceptado por el Ministerio de Salud (Enviar) o el RIPS está en estado VALIDADO (Estado). La respuesta incluye el archivoRetornado con el Código Único de Validación (CUV).
99	422 Unprocessable Entity	false	Enviar, Estado	RIPS rechazado por el Ministerio de Salud. El Ministerio validó la estructura del paquete pero encontró errores en los datos. Revisar el campo archivoRetornado.resultadosValidacion para ver los errores específicos. Corregir los datos y volver a enviar el RIPS.
101	401 Unauthorized	false	Enviar, Estado	Error de autenticación. Las credenciales tokenEmpresa y/o tokenPassword son inválidas o no corresponden a una empresa registrada. Verificar que los tokens sean correctos. Si el problema persiste, contactar al área de integración TFHKA.
102	400 Bad Request / 404 Not Found	false	Enviar, Estado	RIPS no encontrado o idRips inválido. El identificador UUID proporcionado en idRips no existe en el sistema. Verificar el valor del idRips. Si se tiene certeza de que fue creado, contactar al soporte.
109	400 Bad Request	false	Enviar	Error de validación al crear el RIPS. Se presentó un error en la estructura o contenido del request antes de procesar el RIPS. Causas frecuentes: Campos obligatorios faltantes (tokenEmpresa, tokenPassword, tipoRips, ripsJson). Valor de tipoRips inválido (debe ser 01, 02, 03, 04 o 05). Revisar el campo errors en la respuesta para ver los mensajes específicos.
111	400 Bad Request	false	Enviar, Estado	Error de validación de tokens (formato incorrecto). Los tokens no cumplen con el formato requerido. Ambos tokens deben ser cadenas de texto con exactamente 40 caracteres alfanuméricos (letras a-z, A-Z y dígitos 0-9). Verificar que los tokens no contengan caracteres especiales, espacios en blanco ni tengan longitud diferente a 40.
114	409 Conflict	false	Enviar, Estado	RIPS ya procesado. El RIPS identificado con el idRips ya fue aceptado por el Ministerio. No es posible volver a enviarlo. Si se requiere corregir datos o enviar nueva información, crear un nuevo RIPS sin proporcionar idRips.
162	200 OK	false	Estado	RIPS en estado CREADO. El RIPS fue registrado en el sistema pero aún no ha sido enviado al Ministerio de Salud. Usar el método Enviar con el idRips correspondiente para transmitirlo al Ministerio.
500	500 Internal Server Error	false	Enviar, Estado	Error interno del servidor. Se produjo un error inesperado durante el procesamiento de la solicitud. Reintentar la operación. Si el error persiste, contactar al soporte técnico de The Factory HKA Colombia indicando los detalles de la petición.

Método Enviar

Códigos de respuesta específicos del método POST /api/rips/enviar.

Códigos HTTP — Método Enviar

HTTP Status	Código de negocio	Descripción
200 OK	200	El RIPS fue enviado y validado exitosamente por el Ministerio de Salud. Se retorna el CUV en archivoRetornado.codigoUnicoValidacion.
400 Bad Request	109	Error de validación del request. Campos obligatorios faltantes o valor de tipoRips inválido. Revisar campo errors.
400 Bad Request	102	El idRips proporcionado no existe en el sistema.
400 Bad Request	111	Los tokens no tienen el formato correcto (exactamente 40 caracteres alfanuméricos).
401 Unauthorized	101	Los tokens son inválidos o no corresponden a una empresa registrada.
409 Conflict	114	El RIPS ya fue procesado y aceptado. No se puede volver a enviar.
422 Unprocessable Entity	99	El Ministerio de Salud rechazó el RIPS. Revisar archivoRetornado.resultadosValidacion.
500 Internal Server Error	500	Error interno del servidor. Reintentar o contactar soporte.

Acciones recomendadas — Método Enviar

Código	Acción recomendada
200	Guardar el idRips y el CUV (archivoRetornado.codigoUnicoValidacion) para los registros de radicación ante el pagador.
99	Revisar cada objeto en archivoRetornado.resultadosValidacion, identificar el campo con error usando pathFuente, corregirlo y reenviar.
101	Verificar los valores de tokenEmpresa y tokenPassword con el equipo de integración TFHKA.
102	Verificar el UUID del idRips. Si el RIPS existe, contactar soporte.
109	Revisar el campo errors en la respuesta. Verificar que tipoRips sea 01-05 y que todos los campos obligatorios estén presentes.
111	Verificar que ambos tokens tengan exactamente 40 caracteres alfanuméricos sin espacios ni caracteres especiales.
114	El RIPS ya fue aceptado. No reenviar. Si se requiere corrección, crear un nuevo RIPS.
500	Reintentar la operación. Si persiste, contactar soporte técnico con los detalles de la petición.

Método EstadoRIPS

Códigos de respuesta específicos del método POST /api/rips/estado.

Códigos HTTP — Método EstadoRIPS

HTTP Status	Código de negocio	Descripción
200 OK	200	El RIPS está en estado VALIDADO. Se retorna el CUV en archivoRetornado.codigoUnicoValidacion.
200 OK	162	El RIPS está en estado CREADO. Aún no ha sido enviado al Ministerio. Usar el método Enviar.
400 Bad Request	102	El idRips proporcionado no existe en el sistema.
400 Bad Request	111	Los tokens no tienen el formato correcto (exactamente 40 caracteres alfanuméricos).
401 Unauthorized	101	Los tokens son inválidos o no corresponden a una empresa registrada.
409 Conflict	114	El RIPS ya fue procesado y aceptado previamente.
422 Unprocessable Entity	99	El RIPS está en estado RECHAZADO. Revisar archivoRetornado.resultadosValidacion.
500 Internal Server Error	500	Error interno del servidor.

Estados posibles del RIPS

Estado	Código de negocio	estado	archivoRetornado	Descripción
VALIDADO	200	true	Presente con resultState: true	El Ministerio aceptó y validó el RIPS correctamente.
RECHAZADO	99	false	Presente con resultState: false y lista de errores	El Ministerio rechazó el RIPS por errores en los datos.
CREADO	162	false	null	El RIPS fue creado en el sistema pero aún no ha sido enviado al Ministerio. Usar el método Enviar para transmitirlo.
No encontrado	102	false	null	El idRips proporcionado no existe en el sistema.
Error autenticación	101	false	null	Los tokens son inválidos o no corresponden a una empresa registrada.

Copyright

THE FACTORY HKA COLOMBIA
Copyright © 2016 The Factory HKA. Todos los derechos reservados.