Base URL
Autenticación
Todos los endpoints requieren autenticación Bearer Token:Endpoints Principales
Checkout
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /checkout/session | Crear sesión de checkout |
| GET | /checkout/session/validate | Validar token de sesión |
| POST | /checkout/resolve-customer | Buscar o crear cliente |
| POST | /checkout/payment | Procesar pago |
| PATCH | /checkout/payments/{id}/reconcile | Reconciliar pago |
| POST | /checkout/ocr/extract | Extracción OCR de recibo |
| GET | /checkout/company/{id} | Información de empresa para checkout |
| GET | /checkout/plans | Planes disponibles |
| GET | /checkout/company/{id}/plans | Planes de una empresa |
| GET | /checkout/subscription/{id} | Información de suscripción |
| GET | /checkout/transaction/{transactionId}/customer | Cliente de una transacción |
| GET | /checkout/link/{companyId}/{subscriptionId} | Link de checkout |
| GET | /checkout/link/{companyId}/customer/{companyCustomerId} | Link de checkout por cliente |
| POST | /checkout/track | Trackear evento de checkout |
Autenticación
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /auth/register | Crear empresa con usuario owner |
| POST | /auth/login | Autenticación de staff |
| POST | /auth/refresh | Renovar token |
| POST | /auth/logout | Invalidar sesión |
Staff & Permisos
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /staff-users/me | Información del usuario actual |
| GET | /staff-users | Listar staff de la empresa |
| POST | /staff-users/invite | Enviar invitación de staff |
| POST | /staff-users/accept-invitation | Aceptar invitación |
| GET | /permissions/me | Lista de permisos del usuario |
| GET | /permissions/me/ability | Reglas de autorización CASL |
| GET | /permissions/check | Verificar permiso específico |
| GET | /roles | Listar roles disponibles |
| POST | /roles | Crear rol personalizado |
| GET | /roles/{roleKey}/permissions | Permisos de un rol |
Empresas
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /companies/{companyId} | Detalles de empresa |
| PUT | /companies/{companyId} | Actualizar empresa |
| GET | /companies/{companyId}/payment-methods | Métodos de pago |
| POST | /companies/{companyId}/payment-methods | Configurar método de pago |
| GET | /companies/{companyId}/bank-accounts | Cuentas bancarias |
| POST | /companies/{companyId}/bank-accounts | Crear cuenta bancaria |
| POST | /companies/{companyId}/custom-fields | Definir campo personalizado |
| PUT | /companies/{companyId}/ar-policy | Actualizar política AR |
Planes
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /plans/{companyId} | Crear plan |
| GET | /plans/{companyId} | Listar planes (paginado) |
| GET | /plans/{companyId}/{planId} | Detalles de plan |
| PUT | /plans/{companyId}/{planId} | Actualizar plan |
| DELETE | /plans/{companyId}/{planId} | Archivar plan |
| PATCH | /plans/{companyId}/{planId}/restore | Restaurar plan |
Tasas de Cambio
| Método | Endpoint | Descripción |
|---|---|---|
| POST | /exchange-rates/{companyId} | Establecer tasa de cambio |
| GET | /exchange-rates/{companyId}/current | Tasa actual |
| GET | /exchange-rates/{companyId}/all-active | Tasas activas |
| GET | /exchange-rates/{companyId}/history | Historial de tasas |
Pagos
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /payments/company/{companyId} | Listar pagos (filtrado) |
| GET | /payments/company/{companyId}/recent | Pagos recientes |
| GET | /payments/company/{companyId}/export | Exportar CSV |
| POST | /payments/process | Procesar pago manual |
| GET | /payments/{companyId}/{paymentId}/detail | Detalle completo de pago |
| GET | /payments/{id}/status | Estado de pago |
| GET | /payments/{id} | Detalles de pago |
Health
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /health | Health check |
Formato de Respuestas
Éxito
Error
Rate Limits
| Ambiente | Límite |
|---|---|
| Sandbox | 100/min |
| Producción | 1000/min |
Paginación
Los endpoints que retornan listas usan paginación conpage y limit:
Métodos de Pago Soportados
| Código | Descripción | País |
|---|---|---|
pagoMovil | Pago Móvil P2P | 🇻🇪 Venezuela |
debitoInmediato | Débito bancario con OTP | 🇻🇪 Venezuela |
c2p | Pago persona a persona | 🇻🇪 Venezuela |
transferencia | Transferencia bancaria | 🇻🇪 Venezuela |
zelle | Transferencia Zelle | 🇺🇸 USA |
binance | Binance Pay | 🌍 Global |
sinpe | SINPE | 🇨🇷 Costa Rica |