API reference

Configure payout rule

Creates or updates an account-scoped payout rule after withdrawals:approve authorization and the existing financial policy checks.

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

Access model

Access model: SparkGlim session and member permissions
Required scope: withdrawals:approve
Documented availability: Implemented in source

Availability is verified from source, not a live production guarantee.

Use the creator-team member workflow. Reseller access never grants unrestricted database or administrator access.

Headers

Name	Type	Validation
`Authorization`Required Existing SparkGlim bearer session; server account membership and assigned capabilities still authorize each operation.	`string`	Validation: Bearer existing authenticated session token.

Request

Name	Type	Validation
`ownerMemberId`Optional Existing account-scoped relationship or review record; ownership and required capabilities are checked on the server.	`string\|null`	Validation: UUID.
`ownerCreatorId`Optional Existing account-scoped relationship or review record; ownership and required capabilities are checked on the server.	`string\|null`	Validation: UUID.
`status`Optional Requested supported lifecycle state; account and campaign approval rules still control publication and access.	`enum`	Validation: active \| paused \| revoked.
`currency`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`string`	Validation: ISO3.
`resellerFeeRate`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`number`	Validation: >=0.
`sparkglimFeeRate`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`number`	Validation: >=0.
`payoutHoldHours`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`integer`	Validation: >=0.
`minWithdrawalAmount`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`number`	Validation: >=0.
`maxWithdrawalAmount`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`number\|null`	Validation: >=0.
`autoEscalateAboveAmount`Optional Account-scoped payout policy value; the server retains authority over balances, fees, approvals and settlement.	`number\|null`	Validation: >=0.
`metadata`Optional Additional JSON metadata accepted by the documented schema; it never overrides authorization, prices or account ownership.	`object`	Validation: JSON object.

Request

Examples describe the contract and are not executed. Use authorized test records; never paste a real secret into these pages.

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
}

Response

Success response · HTTP 201

json

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

Error response · HTTP 400

json

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

Validation, permissions, unavailable records and temporary service failures use the handler’s HTTP status and error payload.

Limits & retries

Default Server limit: 100 requests per IP per 60 seconds. Resource-specific controls also apply.

Source compatibility

Authorized operations require account-specific testing.

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

Access model

Headers

Request

Request

Response

Limits & retries

Source compatibility

Continue building