Referência API

Configurar regra de pagamento

Cria ou atualiza regra de pagamento após permissão withdrawals:approve e controlos financeiros existentes.

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

Modelo de acesso

Modelo de acesso: Sessão SparkGlim e permissões de membro
Âmbito necessário: withdrawals:approve
Disponibilidade documentada: Implementado no código

Disponibilidade verificada no código, sem garantia de produção.

Use o fluxo de membros da equipa Criador. A revenda não concede acesso ilimitado à base ou administração.

Cabeçalhos

Nome	Tipo	Validação
`Authorization`Obrigatório Sessão Bearer SparkGlim existente; associação e capacidades atribuídas autorizam cada operação no servidor.	`string`	Validação: Token Bearer de uma sessão autenticada existente.

Pedido

Nome	Tipo	Validação
`ownerMemberId`Opcional Relação ou revisão existente da conta; propriedade e capacidades são verificadas no servidor.	`string\|null`	Validação: UUID.
`ownerCreatorId`Opcional Relação ou revisão existente da conta; propriedade e capacidades são verificadas no servidor.	`string\|null`	Validação: UUID.
`status`Opcional Estado suportado pedido; aprovação controla publicação e acesso.	`enum`	Validação: active \| paused \| revoked.
`currency`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`string`	Validação: ISO3.
`resellerFeeRate`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`number`	Validação: >=0.
`sparkglimFeeRate`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`number`	Validação: >=0.
`payoutHoldHours`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`integer`	Validação: >=0.
`minWithdrawalAmount`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`number`	Validação: >=0.
`maxWithdrawalAmount`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`number\|null`	Validação: >=0.
`autoEscalateAboveAmount`Opcional Valor da política de pagamento da conta; servidor controla saldos, taxas, aprovações e liquidação.	`number\|null`	Validação: >=0.
`metadata`Opcional Metadados JSON aceites; nunca substituem autorização, preços ou propriedade.	`object`	Validação: Objeto JSON.

Pedido

Os exemplos descrevem o contrato e não são executados. Use registos de teste autorizados; nunca cole segredos reais aqui.

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
}

Resposta

Resposta de sucesso · HTTP 201

json

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

Resposta de erro · HTTP 400

json

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

Validação, permissões, registos indisponíveis e falhas usam estado HTTP e erro do controlador.

Limites e novas tentativas

Limite padrão: 100 pedidos por IP em 60 segundos. Aplicam-se também controlos específicos.

Compatibilidade do código

As operações autorizadas exigem testes específicos da conta.

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 acesso

Cabeçalhos

Pedido

Pedido

Resposta

Limites e novas tentativas

Compatibilidade do código

Continuar a desenvolver