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.

​
Antes de comenzar

Una API key de Staging (sk_test_*)
Un endpoint HTTPS para recibir webhooks (opcional pero recomendado)
Un cliente HTTP (cURL, fetch, requests, etc.)
Si aún no tienes API key, un admin de tu empresa puede crear una desde el dashboard de Cobrix o vía la API de keys.

​
Paso 1 · Configura tu entorno

.env
COBRIX_API_KEY=sk_test_acme_PqL9Kx2Yj7mN...
COBRIX_BASE_URL=https://api-staging.cobrix.co

​
Paso 2 · Crea un pago hosted

El modo hosted genera un link de checkout al cual rediriges al cliente. 
curl -X POST "$COBRIX_BASE_URL/api/external/payments" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $COBRIX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "customerEmail": "[email protected]",
    "customerName": "Jane Doe",
    "amountMinor": 15000,
    "currency": "VES",
    "description": "Suscripción mensual",
    "callbackUrl": "https://tu-app.com/webhooks/cobrix",
    "externalReference": "order-123"
  }'
Respuesta 201 Created: 
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending",
  "mode": "hosted",
  "amountMinor": 15000,
  "currency": "VES",
  "checkoutUrl": "https://checkout.cobrix.co/checkout/eyJhbGci...",
  "expiresAt": "2026-03-27T14:30:00.000Z",
  "createdAt": "2026-03-26T14:30:00.000Z"
}

​
Paso 3 · Redirige al cliente

window.location.href = payment.checkoutUrl
El cliente completa el pago en el checkout de Cobrix. Los pagos hosted expiran en 24 horas.

​
Paso 4 · Recibe el webhook

Cuando el pago se complete, Cobrix hará un POST a tu callbackUrl: 
{
  "eventType": "external_payment.completed",
  "resourceType": "external_payment",
  "companyId": "company-uuid",
  "payload": {
    "id": "a1b2c3d4-...",
    "status": "completed",
    "amountMinor": 15000,
    "currency": "VES",
    "invoiceId": "inv-...",
    "paymentId": "pay-..."
  }
}
Los webhooks son fire-and-forget — no se reintentan automáticamente. Usa Get Payment para validar el estado en operaciones críticas.

​
Alternativa · Pago directo (sin checkout)

Para POS o facturación backend-to-backend, usa el modo direct. Se completa de inmediato. 
curl -X POST "$COBRIX_BASE_URL/api/external/payments/direct" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $COBRIX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "customerEmail": "[email protected]",
    "amountMinor": 15000,
    "currency": "VES",
    "paymentMethod": "pago_movil",
    "description": "POS #456"
  }'
La respuesta trae status: "completed" de inmediato. Ver Direct Payments.

​
Próximos pasos

Flujo hosted

Detalle del ciclo de vida y callbacks

Idempotencia

Reintentos seguros con Idempotency-Key

Webhooks

Procesa external_payment.completed

Certificación

Prepárate para producción