Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cobrix.co/llms.txt

Use this file to discover all available pages before exploring further.

URL base

AmbienteURL
Staginghttps://api-staging.cobrix.co
Producciónhttps://api.cobrix.co
Prefijo de los endpoints de pagos: /api/external/payments.

Autenticación

Todos los endpoints requieren el header X-API-Key:
X-API-Key: sk_live_acme_PqL9Kx2Yj7mN...
Ver Autenticación para el formato y buenas prácticas.

Endpoints

Pagos

MétodoEndpointDescripción
POST/api/external/paymentsCrear pago hosted (checkout)
POST/api/external/payments/directCrear pago directo (backend-to-backend)
GET/api/external/payments/{id}Obtener un pago
GET/api/external/paymentsListar pagos (paginado)
DELETE/api/external/payments/{id}Cancelar un pago pendiente
Detalle en Payments.

Gestión de API Keys (admin, autenticación JWT)

MétodoEndpointDescripción
POST/api/companies/{companyId}/api-keysCrear key
GET/api/companies/{companyId}/api-keysListar keys
DELETE/api/companies/{companyId}/api-keys/{keyId}Revocar key
POST/api/companies/{companyId}/api-keys/{keyId}/rotateRotar key
Detalle en API Keys.

Headers comunes

HeaderRequerido enDescripción
X-API-KeyTodos los endpoints de pagosAPI key de la empresa
Idempotency-KeyPOSTUUID v4 único por operación
Content-TypePOSTapplication/json

Formato de respuesta

Éxito

{
  "id": "a1b2c3d4-...",
  "status": "pending",
  "mode": "hosted",
  "amountMinor": 15000,
  "currency": "VES",
  "createdAt": "2026-03-26T14:30:00.000Z"
}

Error

{
  "statusCode": 400,
  "message": "Customer email must be a valid email",
  "error": "Bad Request",
  "timestamp": "2026-03-26T14:30:00.000Z",
  "path": "/api/external/payments"
}
Ver Errores para la lista completa de códigos.

Paginación

GET /api/external/payments acepta page (default 1) y limit (default 20) y devuelve:
{
  "payments": [ /* ... */ ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Rate limits

Cada API key tiene un límite de 60 requests/minuto por defecto (configurable). Cuando se excede, la API responde 429 Too Many Requests.

Unidades monetarias

Los montos se expresan siempre en la unidad mínima de la moneda. Ejemplos:
ValorMonedaEquivalente
10000VES100,00 VES
5000USD50,00 USD
10000CRC100,00 CRC
Monedas soportadas: VES, USD, CRC.