Docs

Empezar con Pharos

Elige una tarea del panel o conecta tu aplicación al checkout alojado.

Usa el panel para administrar cobros y operaciones financieras, o conecta tu aplicación al checkout alojado mediante la API.

Elige por dónde empezar

Tu tareaGuía
Crear una oferta y compartir su enlaceEnlaces de pago
Crear una factura para un clienteFacturas
Administrar facturación recurrenteSuscripciones
Revisar facturas de proveedores y preparar pagosPagos
Abrir una cuenta financiera o consultar el saldoCuentas financieras
Integrar el checkout en tu aplicaciónCart Checkout

Prepara tu cuenta y Sandbox

El registro crea una cuenta de Producción. Desde el selector de cuentas puedes crear otra cuenta, crear una subcuenta que hereda el equipo de la cuenta principal o abrir el Sandbox vinculado. Los administradores también pueden crear y abrir el Sandbox desde Panel → Configuración → Sandboxes.

Un Sandbox nuevo no contiene clientes, facturas, pagos, cuentas financieras, integraciones ni claves de API. Configura los datos de prueba y la conexión de pagos antes de probar. Confirma la cuenta y el entorno activos antes de hacer cambios.

Autenticación

Para integrar la API, crea una clave en la configuración para desarrolladores del panel. Todos los endpoints /api/v1 requieren el encabezado x-api-key. Conserva la clave en tu servidor.

Esta solicitud usa un entorno de desarrollo local:

curl -H 'x-api-key: YOUR_API_KEY' \
  'http://localhost:3000/api/v1/products?limit=20'

Primera integración

  1. Confirma la cuenta conectada con GET /api/v1/account y una clave con permiso READ.
  2. Lista productos o consulta IDs guardados con GET /api/v1/products/{id} o GET /api/v1/products?ids[]=.... Consulta Paginación para interpretar listas y cursores.
  3. Crea un enlace de pago reutilizable o una Checkout Session para un carrito controlado por tu backend.
  4. Configura Webhooks. Verifica las firmas y evita procesar entregas duplicadas antes de entregar una compra.
  5. Completa una compra en Sandbox, revisa la factura y el pago, y verifica la recepción del evento firmado invoice.paid antes de pasar a producción.

Guías principales

Conceptos clave

Productos

Los productos describen lo que vendes. Los planes definen cómo cobras y los precios indican el importe en cada moneda.

Enlaces de pago

Un enlace de pago es una URL reutilizable del checkout alojado. Al iniciar el checkout, Pharos crea o reanuda una Checkout Session con una copia de la oferta. Úsalo para compartir la misma oferta en tu sitio, mensajes o campañas.

Webhooks

Los webhooks notifican a tu backend sobre eventos de checkout, pagos y suscripciones. Pharos firma las entregas con Pharos-Signature. Una redirección o pantalla de éxito no confirma un pago: entrega una compra pagada sólo después de verificar el evento firmado invoice.paid.