Get All Settings
Retrieve all platform settings grouped by category.
Example Request
Example Response (200)
Get Settings by Category
The settings category. One of general, payments, security, notifications.
Example Request
Example Response (200)
Update Settings
Update one or more platform settings. Only the fields provided will be updated.
General platform settings.
The display name of the platform.
Platform support email address.
Enable or disable maintenance mode.
Payment-related settings.
Minimum accepted payment amount.
Maximum accepted payment amount.
Platform fee as a percentage.
Security-related settings.
Maximum failed login attempts before lockout.
Session timeout in minutes.
Notification-related settings.
Enable or disable email notifications.
Number of retry attempts for failed webhooks.
Example Request
Example Response (200)
Email Templates
List Email Templates
Retrieve all configured email templates.
Example Response (200)
Create Email Template
Unique template identifier name (e.g., payment_confirmation).
Email subject line. Supports {{variable}} placeholders.
HTML email body. Supports {{variable}} placeholders.
List of variable names used in the template.
Whether the template is active.
Example Response (201)
Update Email Template
The unique email template identifier.
Updated email subject line.
Updated list of variable names.
Enable or disable the template.
Example Response (200)
Legal Documents
List Legal Documents (Admin)
Retrieve all legal documents including drafts.
Example Response (200)
Create Legal Document
Document type. One of terms_of_service, privacy_policy, aml_policy, refund_policy.
Document content in Markdown format.
Version string (e.g., 1.0, 2.1).
Whether to immediately publish this document. Setting to true deactivates the previous active version of the same type.
Example Response (201)
Update Legal Document
The unique legal document identifier.
Updated document content.
Activate or deactivate the document.
Example Response (200)
Public Active Legal Documents
Retrieve all currently active legal documents. This endpoint is public and does not require authentication.
Example Response (200)