Manejo de errores
Estandar para el manejo de errores via API.
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: 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.
Errores de procesamiento de pagos
Código en texto | Código numérico | Descripción |
---|---|---|
internal_error | 10101 | Error interno. Comunícate con soporte para resolver el problema. |
card_cvv | 10102 | CVV inválido. |
insufficient_funds | 10103 | Fondos insuficientes. |
card_number | 10104 | Número de tarjeta inválido. |
fraudulent | 10105 | Transacción fraudulenta. |
stolen | 10106 | Tarjeta robada. |
currency_not_supported | 10107 | Moneda no soportada. |
card_velocity | 10108 | Se ha excedido la cantidad de intentos de pago permitidos para esta tarjeta. |
card_date | 10109 | Fecha de expiración inválida. |
transaction_not_found | 10110 | Transacción no encontrada. |
min_amount | 10111 | El monto de la transacción es menor al mínimo permitido. |
account_not_connected | 10112 | El usuario ha desconectado su cuenta. |
account_blocked | 10113 | La cuenta ha sido bloqueada. |
account_closed | 10114 | La cuenta ha sido cerrada. |
account_does_not_belong_to_customer | 10115 | La cuenta no pertenece al usuario. |
transaction_expired | 10116 | El usuario no ha completado la transacción en el tiempo permitido. |
card_generic_error | 10117 | Error genérico al procesar el pago con tarjeta, el banco no proporcionó más información. |
transaction_rejected | 10118 | El usuario no aceptó o rechazó la transacción en el banco. |
unknown | 10119 | Error desconocido. Comunícate con soporte para resolver el problema. |
bank_is_not_available | 10120 | El banco no se encuentra disponible para iniciar la transacción. |
card_restricted | 10121 | Tarjeta restringida, pídele al usuario que se comunique con su banco. |
card_expired | 10122 | Tarjeta expirada, pídele al usuario que actualice su tarjeta. |
account_is_not_authorized | 10123 | La cuenta no está autorizada para realizar cargos. |
transaction_temporally_blocked | 10124 | La transacción ha sido bloqueada temporalmente. |
account_failed | 10125 | Esta cuenta no ha sido aceptada. |
customer_data_invalid | 10126 | Datos del cliente inválidos. |
max_amount | 10127 | La transacción supera el monto máximo permitido para este método de pago. |
Was this page helpful?