SiPagoDocs
Docs para IA

Fechas, paginación y errores

Fechas

Las fechas se envían en formato AAAA-MM-DD (por ejemplo, 2024-05-24). Los rangos incluyen el día inicial y el final.

Paginación

Los listados de movimientos y depósitos son paginados. El número de página va en la ruta ( :page ) y empieza en 0. Cada respuesta indica si hay más resultados:

CampoTipoDescripción
pagenumberPágina devuelta.
existMorebooleantrue si hay otra página: pedí page + 1. false si es la última.
listTrxarrayResultados de la página.

Errores

Además de los errores de autenticación, la API puede responder:

CódigoCuándo
400 Bad RequestFalta un campo obligatorio o tiene el tipo incorrecto. La respuesta detalla qué campo falló.
401 UnauthorizedFalta la clave de API o no es válida.
500 Internal Server ErrorParámetros incorrectos (por ejemplo, una fecha mal formada) o un error interno.

Ejemplo 400 · validación

{
  "statusText": "Bad Request",
  "jsonSchemaValidation": true,
  "validations": {
    "body": [
      {
        "keyword": "required",
        "dataPath": "",
        "schemaPath": "#/required",
        "params": { "missingProperty": "amount" },
        "message": "should have required property 'amount'"
      }
    ]
  }
}

Ejemplo 500

{
  "status": 500,
  "message": "status 500",
  "timestamp": "2024-05-28T12:30:04Z"
}