Referencia API

Configurar regla de desembolso

Crea o actualiza regla de desembolso tras permiso withdrawals:approve y controles financieros existentes.

POSThttps://api.sparkglim.net/api/white-label/portal/reseller/payout-rules

Modelo de acceso

Modelo de acceso: Sesión SparkGlim y permisos de miembro
Permiso requerido: withdrawals:approve
Disponibilidad documentada: Implementado en código

Disponibilidad verificada en el código, sin garantía de producción.

Use el flujo de miembros del equipo creador. La reventa no concede acceso ilimitado a base de datos o administración.

Encabezados

Nombre	Tipo	Validación
`Authorization`Obligatorio Sesión Bearer SparkGlim existente; la membresía y capacidades asignadas autorizan cada operación en servidor.	`string`	Validación: Token Bearer de una sesión autenticada existente.

Solicitud

Nombre	Tipo	Validación
`ownerMemberId`Opcional Relación o revisión existente de cuenta; propiedad y capacidades se comprueban en servidor.	`string\|null`	Validación: UUID.
`ownerCreatorId`Opcional Relación o revisión existente de cuenta; propiedad y capacidades se comprueban en servidor.	`string\|null`	Validación: UUID.
`status`Opcional Estado admitido solicitado; aprobación controla publicación y acceso.	`enum`	Validación: active \| paused \| revoked.
`currency`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`string`	Validación: ISO3.
`resellerFeeRate`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`number`	Validación: >=0.
`sparkglimFeeRate`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`number`	Validación: >=0.
`payoutHoldHours`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`integer`	Validación: >=0.
`minWithdrawalAmount`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`number`	Validación: >=0.
`maxWithdrawalAmount`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`number\|null`	Validación: >=0.
`autoEscalateAboveAmount`Opcional Valor de política de desembolso de cuenta; servidor controla saldos, cargos, aprobaciones y liquidación.	`number\|null`	Validación: >=0.
`metadata`Opcional Metadatos JSON admitidos; nunca sustituyen autorización, precios o propiedad.	`object`	Validación: Objeto JSON.

Solicitud

Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.

POST /api/white-label/portal/reseller/payout-rules

http

POST /api/white-label/portal/reseller/payout-rules HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "currency": "GHS",
  "payoutHoldHours": 24,
  "minWithdrawalAmount": 0
}

Respuesta

Respuesta correcta · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  }
}

Respuesta de error · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>"
}

Validación, permisos, registros no disponibles y fallos usan el estado HTTP y error del controlador.

Límites y reintentos

Límite predeterminado: 100 solicitudes por IP en 60 segundos. También se aplican controles específicos.

Compatibilidad del código

Las operaciones autorizadas requieren pruebas específicas de la cuenta.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/reseller-service.ts
server/src/white-label/schemas.ts

Modelo de acceso

Encabezados

Solicitud

Solicitud

Respuesta

Límites y reintentos

Compatibilidad del código

Seguir desarrollando