Manejo de errores

Cuando suceda un error en la petición. El mensaje devuelto en el objeto status será mostrado al usuario en el flujo que esté realizando, por lo cual se sugiere manejar mensajes acordes y amigables con el usuario. Usted dispondrá del idioma del usuario enviado en cada petición locale por lo cual, puede soportar traducciones para dicho mensaje de error.

Ejemplo del mensaje

{
  "status": {
    "status": "FAILED",
    "reason": 999,
    "message": "Usted cuenta con un proceso de pago pendiente",
    "date": "2025-07-07T11:30:37-05:00"
    }
}

Autenticación fallida

Cuando las credenciales de autenticación del servicio externo son incorrectas se debe retornar una respuesta fallida especificando el status como FAILED.

Ejemplo de respuesta

{
  "status": {
    "status": "FAILED",
    "reason": 401,
    "message": "Autenticación fallida", 
    "date": "2025-07-07T11:30:37-05:00"
    }
}

Asentamiento

Para cualquiera de los siguientes casos el servicio debe retornar una respuesta fallida.

Asentamiento ya realizado

Sucede cuando una factura ya se encuentra asentada en el servicio externo.
Para este caso es muy importante el uso del reason AP ya que le permite a Micrositios identificar el escenario y asentar la factura en su base de datos interna.

Ejemplo de respuesta

{
 "status": {
   "status": "FAILED",
   "reason": "AP",
   "message": "Ya se encuentra pagada",
   "date": "2025-07-07T12:01:29-05:00"
    }
}

Asentamiento de factura no existente

Sucede cuando se intenta asentar una factura que no existe en el servicio externo

Ejemplo de respuesta

{
 "status": {
   "status": "FAILED",
   "reason": "NF",
   "message": "No existe la factura con ese identificador",
   "date": "2025-07-07T12:13:02-05:00"
    }
}