Skip to main content

Base URL

https://sandbox-api.cobrix.co/api

Autenticación

Todos los endpoints requieren autenticación Bearer Token:
Authorization: Bearer tu_access_token

Endpoints Principales

Checkout

MétodoEndpointDescripción
POST/checkout/sessionCrear sesión de checkout
GET/checkout/session/validateValidar token de sesión
POST/checkout/resolve-customerBuscar o crear cliente
POST/checkout/paymentProcesar pago
PATCH/checkout/payments/{id}/reconcileReconciliar pago
POST/checkout/ocr/extractExtracción OCR de recibo
GET/checkout/company/{id}Información de empresa para checkout
GET/checkout/plansPlanes disponibles
GET/checkout/company/{id}/plansPlanes de una empresa
GET/checkout/subscription/{id}Información de suscripción
GET/checkout/transaction/{transactionId}/customerCliente 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/trackTrackear evento de checkout

Autenticación

MétodoEndpointDescripción
POST/auth/registerCrear empresa con usuario owner
POST/auth/loginAutenticación de staff
POST/auth/refreshRenovar token
POST/auth/logoutInvalidar sesión

Staff & Permisos

MétodoEndpointDescripción
GET/staff-users/meInformación del usuario actual
GET/staff-usersListar staff de la empresa
POST/staff-users/inviteEnviar invitación de staff
POST/staff-users/accept-invitationAceptar invitación
GET/permissions/meLista de permisos del usuario
GET/permissions/me/abilityReglas de autorización CASL
GET/permissions/checkVerificar permiso específico
GET/rolesListar roles disponibles
POST/rolesCrear rol personalizado
GET/roles/{roleKey}/permissionsPermisos de un rol

Empresas

MétodoEndpointDescripción
GET/companies/{companyId}Detalles de empresa
PUT/companies/{companyId}Actualizar empresa
GET/companies/{companyId}/payment-methodsMétodos de pago
POST/companies/{companyId}/payment-methodsConfigurar método de pago
GET/companies/{companyId}/bank-accountsCuentas bancarias
POST/companies/{companyId}/bank-accountsCrear cuenta bancaria
POST/companies/{companyId}/custom-fieldsDefinir campo personalizado
PUT/companies/{companyId}/ar-policyActualizar política AR

Planes

MétodoEndpointDescripció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}/restoreRestaurar plan

Tasas de Cambio

MétodoEndpointDescripción
POST/exchange-rates/{companyId}Establecer tasa de cambio
GET/exchange-rates/{companyId}/currentTasa actual
GET/exchange-rates/{companyId}/all-activeTasas activas
GET/exchange-rates/{companyId}/historyHistorial de tasas

Pagos

MétodoEndpointDescripción
GET/payments/company/{companyId}Listar pagos (filtrado)
GET/payments/company/{companyId}/recentPagos recientes
GET/payments/company/{companyId}/exportExportar CSV
POST/payments/processProcesar pago manual
GET/payments/{companyId}/{paymentId}/detailDetalle completo de pago
GET/payments/{id}/statusEstado de pago
GET/payments/{id}Detalles de pago

Health

MétodoEndpointDescripción
GET/healthHealth check

Formato de Respuestas

Éxito

{
  "id": "...",
  "status": "active",
  ...
}

Error

{
  "error": "ERROR_CODE",
  "message": "Descripción del error",
  "details": { ... },
  "requestId": "req_xxx"
}

Rate Limits

AmbienteLímite
Sandbox100/min
Producción1000/min
Headers de respuesta:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1706023860

Paginación

Los endpoints que retornan listas usan paginación con page y limit:
GET /payments/company/{companyId}?page=1&limit=20
Respuesta:
{
  "data": [...],
  "total": 150,
  "page": 1,
  "limit": 20,
  "totalPages": 8
}

Métodos de Pago Soportados

CódigoDescripciónPaís
pagoMovilPago Móvil P2P🇻🇪 Venezuela
debitoInmediatoDébito bancario con OTP🇻🇪 Venezuela
c2pPago persona a persona🇻🇪 Venezuela
transferenciaTransferencia bancaria🇻🇪 Venezuela
zelleTransferencia Zelle🇺🇸 USA
binanceBinance Pay🌍 Global
sinpeSINPE🇨🇷 Costa Rica