Referencia API
URLs base, autenticación y las convenciones centrales de la API de Vecnet — con páginas interactivas por endpoint generadas desde la especificación OpenAPI.
La API de Vecnet es una API REST de JSON de entrada y JSON de salida para el checkout alojado, las ligas de pago, las transacciones, los webhooks y la bitácora de auditoría. Esta página es el resumen; las páginas por endpoint de esta sección se generan desde la especificación OpenAPI, así que siempre coinciden con la API en vivo.
Cada página de endpoint incluye un playground que llama al ambiente
sandbox. Pega una llave vk_test_… en el campo de autorización para
probar en vivo; nunca uses una llave de producción ahí.
URLs base
| Ambiente | URL base | Uso |
|---|---|---|
| Sandbox | https://staging-api.vecnet.io | Integración y pruebas. Sin dinero real. |
| Producción | https://api.vecnet.io | Cobros reales. |
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.
Verificación de estado (sin autenticación):
curl https://staging-api.vecnet.io/healthAutenticación
| Quién llama | Encabezado | Dónde se usa |
|---|---|---|
| Tu integración (llave de API) | Authorization: Token <llave> o X-API-Key: <llave> | Checkout alojado, ligas de pago y llamadas servidor a servidor. |
| Un operador del panel (JWT) | Authorization: Bearer <jwt> + X-Merchant-Id: mrc_… | Recursos administrativos desde el panel. |
# Llave de API (servidor a servidor)
curl https://staging-api.vecnet.io/api/transactions \
-H "Authorization: Token vk_test_1a2b3c4d5e6f7a8b9c0d"
# Operador (panel), limitado a un comercio
curl https://staging-api.vecnet.io/api/transactions \
-H "Authorization: Bearer <jwt>" \
-H "X-Merchant-Id: mrc_3f9a2c1b"Consulta Autenticación para el detalle de cada esquema.
Convenciones de lista
Los endpoints de lista aceptan estos parámetros de consulta:
limit: por defecto 50, máximo 200offset, opageorderydir:ascodescsearchfromyto:YYYY-MM-DD- más los filtros de igualdad de cada recurso
Toda respuesta de lista es un sobre con las filas en data más los metadatos
de paginación:
{
"data": [],
"count": 128,
"limit": 50,
"offset": 0
}Montos y fechas
Los montos son enteros en centavos; la moneda por defecto es MXN. Las
marcas de tiempo son ISO 8601, salvo created_at y modified_at en la sesión
de checkout, que son milisegundos desde época. Consulta
Convenciones.
Errores
Las respuestas de error son un objeto JSON con un solo campo error. Un rechazo
de tarjeta devuelve 402 con declined: true. Consulta Errores.
Secciones
Checkout alojado
Sesiones de checkout y ligas de pago con tu llave de API.
Transacciones
Listar, consultar y reembolsar pagos.
Webhooks
Endpoints, catálogo de eventos, entregas y reenvíos.
Llaves de API
Crear y listar llaves del comercio.
Eventos
La bitácora de auditoría.
Público
Lo que consulta la página alojada, sin autenticación.