Convenciones

Estas convenciones aplican a todos los endpoints de la API de Vecnet. Apréndelas una vez y valen en todas partes.

URLs base

Las páginas alojadas (checkout y ligas de pago) viven en https://pagos.vecnet.io. Usa siempre la url exacta que devuelve la API; nunca construyas el host a mano.

La verificación de estado no necesita autenticación:

curl https://api.vecnet.io/health

JSON de entrada, JSON de salida

Toda petición y toda respuesta usan JSON. Envía Content-Type: application/json en las peticiones con cuerpo y espera de vuelta un objeto JSON o un sobre de lista.

Los montos van siempre en unidades mínimas

Todos los montos son enteros en las unidades mínimas de la moneda (centavos). La moneda por defecto es MXN.

Para cobrar MXN 250.00, multiplica por 100 y envía el entero 25000. Para mostrar un monto guardado, divide entre 100.

IDs con prefijo

Cada ID de recurso lleva un prefijo corto para que su tipo sea evidente a simple vista.

Parámetros de consulta en listas

Los endpoints de lista (GET /api/<recurso>) aceptan un conjunto común de parámetros:

Cada recurso acepta además sus propios filtros de igualdad (por ejemplo rail, terminal_id o status en transacciones).

curl "https://api.vecnet.io/api/transactions?limit=25&order=created_at&dir=desc&rail=inperson_cp" \
  -H "Authorization: Token vk_live_1a2b3c4d5e6f7a8b9c0d"

El sobre de lista

Las respuestas de lista son siempre un sobre: un arreglo data más los metadatos de paginación.

{
  "data": [
    { "id": "txn_a1b2c3", "amount_cents": 25000, "currency": "MXN" },
    { "id": "txn_d4e5f6", "amount_cents": 9900, "currency": "MXN" }
  ],
  "count": 2,
  "limit": 50,
  "offset": 0
}

Marcas de tiempo

Las marcas de tiempo son cadenas ISO 8601, por ejemplo 2026-06-22T14:30:00.000Z.

{
  "id": "txn_a1b2c3",
  "created_at": "2026-06-22T14:30:00.000Z"
}

El mapa de recursos

Cada objeto de dominio se expone con la misma forma CRUD de cinco rutas en /api/<recurso>: GET (listar), GET /:id (consultar), POST (crear), PUT /:id (actualizar), DELETE /:id (eliminar). La tenencia determina el alcance.