API reference
Configure approved payment method
Creates a reseller payment-method configuration under the assigned payment permission and approval policy; it does not enable arbitrary providers.
https://api.sparkglim.net/api/white-label/portal/reseller/payment-methodsAccess model
- Access model
- SparkGlim session and member permissions
- Required scope
payments:write- 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 |
|---|---|---|
AuthorizationRequiredExisting SparkGlim bearer session; server account membership and assigned capabilities still authorize each operation. | string | Validation: Bearer existing authenticated session token. |
Request
| Name | Type | Validation |
|---|---|---|
providerTypeRequiredApproved reseller payment-method configuration; sensitive provider details remain protected by the server. | enum | Validation: paystack | expresspay | hubtel | manual. |
methodTypeRequiredApproved reseller payment-method configuration; sensitive provider details remain protected by the server. | enum | Validation: bank | mobile_money | card | wallet. |
ownerMemberIdOptionalExisting account-scoped relationship or review record; ownership and required capabilities are checked on the server. | string|null | Validation: UUID. |
ownerCreatorIdOptionalExisting account-scoped relationship or review record; ownership and required capabilities are checked on the server. | string|null | Validation: UUID. |
labelOptionalApproved reseller payment-method configuration; sensitive provider details remain protected by the server. | string|null | Validation: <=120. |
publicDetailsOptionalApproved reseller payment-method configuration; sensitive provider details remain protected by the server. | object | Validation: JSON object. |
encryptedDetailsOptionalApproved reseller payment-method configuration; sensitive provider details remain protected by the server. | object | Validation: server-protected configuration; never publish credentials. |
metadataOptionalAdditional 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/payment-methods HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json
{
"providerType": "manual",
"methodType": "bank",
"label": "Example approved method"
}Response
{
"success": true,
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"status": "pending"
}
}{
"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.tsserver/src/api/routes/white-label.tsserver/src/white-label/reseller-service.tsserver/src/white-label/schemas.ts