La API de OnePay utiliza códigos de estado HTTP para indicar la naturaleza de los errores que pueden ocurrir durante el procesamiento de una solicitud. Estos códigos de estado son acompañados por un cuerpo de respuesta estandarizado que proporciona detalles adicionales para facilitar la resolución de problemas. A continuación, se detalla cómo interpretar y manejar estos errores eficazmente.

Formato Estándar de Respuesta de Error Cuando ocurre un error, la API responde con un código de estado HTTP 4XX y un cuerpo de respuesta en formato JSON estructurado de la siguiente manera:

{
  "message":"Descripción del error en texto.",
  "code":"Código numérico del mensaje de error",
  "code_name":"Código en texto para el mensaje de error",
  "erros": [
    {
      "key": "name",
      "description": "El campo name, es un campo requerido"
    }
  ]
}
  • message: Proporciona una descripción comprensible del error, diseñada para ser leída por desarrolladores.
  • code: Un código numérico que identifica de manera única el error específico que ha ocurrido.
  • code_name: Un identificador textual que representa el tipo de error, facilitando su rápida identificación sin necesidad de referenciar documentación adicional.
  • errors: es el resultado del proceso de validación de cada uno de los campos cuando intentas consumir el api.

​
Guía para la Resolución de Errores

Los errores devueltos por nuestra API están pensados para ofrecer suficiente información que permita a los desarrolladores identificar y corregir el problema de manera eficiente. A continuación, se ofrecen algunas recomendaciones generales para el manejo de estos errores:

  • Análisis del Código de Estado HTTP: Comience por revisar el código de estado HTTP para obtener una comprensión general de la naturaleza del error (p.ej., errores de cliente 4XX, errores de servidor 5XX).
  • Revisión del Mensaje de Error: El campo message en la respuesta proporciona una explicación detallada del error. Este debe ser el primer recurso para entender el problema específico.
  • Consultar el Código Específico del Error: Utilice el code y code_name para buscar en la documentación de la API detalles adicionales y posibles soluciones para el error indicado.
  • Implementar un manejo de errores detallado y específico no solo mejora la robustez de las integraciones con la API de OnePay, sino que también asegura una experiencia de usuario final más fluida y predecible. Se recomienda a los desarrolladores diseñar sus aplicaciones para que respondan de manera adecuada a los distintos errores, proporcionando retroalimentación útil al usuario final cuando sea necesario.