API de Ripei
Ripei es una plataforma de cobros recurrentes para empresas venezolanas. Esta documentación cubre la integración vía API: registrar clientes, definir planes, crear suscripciones y recibir notificaciones de pago en tu sistema.
Base URL
| Entorno | URL |
|---|---|
| QA / pruebas | https://api.qa.pagosripei.com |
| Producción | https://api.pagosripei.com |
Todas las peticiones llevan dos headers obligatorios — ver Autenticación:
Authorization: Bearer <tu_token_de_integración>
company: <id_de_tu_empresa>Cómo se relacionan los modelos
┌──────────────────────────────┐
│ COMPANY │
│ (tu empresa, la crea el │
│ equipo de Ripei) │
└──────┬──────────┬────────────┘
│ │
┌───────────────┘ └──────────────┐
▼ ▼
┌───────────────┐ ┌─────────────────┐
│ GROUP │ │ PLAN │
│(grupo familiar│ │ (monto + fre- │
│ de clientes) │ │ cuencia de │
└──────┬────────┘ │ facturación) │
│ └───────┬─────────┘
▼ │ opcional
┌───────────────┐ ┌───────▼─────────┐
│ COMPANY USER │ │ PLAN SETTINGS │
│ (cliente que │ │ (cuotas: número │
│ paga) │ │ y monto por │
└──────┬────────┘ │ cuota) │
│ └───────┬─────────┘
│ │
└────────────────┬────────────────────────┘
▼
┌─────────────────┐
│ SUBSCRIPTION │
│ (companyUser + │
│ plan) │
└────────┬────────┘
│ genera automáticamente
▼
┌─────────────────┐ ┌──────────────────┐
│ BILL │──pago──▶ WEBHOOK │
│ (factura) │ │ payment.received │
└─────────────────┘ │ bill.paid │
└──────────────────┘Orden de creación obligatorio. Cada modelo depende del anterior — no puedes crear una suscripción sin un cliente y un plan, ni un cliente (con rol de grupo) sin un grupo:
- Grupo — contenedor de clientes.
- Cliente — requiere
groupId. - Plan — y opcionalmente su configuración de cuotas, que se crea ANTES del plan que la referencia.
- Suscripción — une cliente + plan. A partir de aquí Ripei genera las facturas automáticamente según la frecuencia del plan.
- Factura manual — solo si necesitas cobrar algo fuera del ciclo automático.
Flujo básico de integración
- Solicita al equipo de Ripei tu token de integración con los scopes que necesites.
- Crea (o asocia) un grupo y registra a tus clientes.
- Define tus planes y suscribe a cada cliente.
- Configura el webhook para recibir en tu sistema las notificaciones de
pago (
payment.received) y de factura pagada (bill.paid). - Ripei se encarga del ciclo: genera las facturas, envía recordatorios (email/SMS/WhatsApp) y procesa los pagos.
Last updated on