v1

latestOpenAPI 3.1.0Proprietary2026-07-1434570540.9 KB
Admin

Create a Fee Rule

Creates a new fee rule or override.

post/admin/fees

Request body

agentsstring[]

Agents the rule targets. Empty for 'global', exactly one for 'agent', exactly two (ordered sender, recipient) for 'pair'.

effectiveFromstring date-time

When the rule becomes effective (RFC 3339). Defaults to now when omitted.

effectiveUntilstring date-time

Optional expiry after which the rule no longer applies (RFC 3339).

feeIdstring

Identifier for the fee rule. Optional on create; the server generates one when omitted.

ratestring required

Fee rate as a non-negative decimal fraction (e.g. '0.0005'). Must not exceed the configured maximum (default '0.05').

reasonstring

Free-text justification recorded in the audit trail.

scope'global' | 'agent' | 'pair' required

Match scope of the rule. 'global' applies to all agents, 'agent' to one agent, 'pair' to a specific sender/recipient pair.

transactionType'sale' | 'payment' | 'subscription' | 'group_fee' | 'revenue_share' required

Fee-bearing ledger transaction type the rule applies to.

Response

OK

object required