Create a Fee Rule

post

https://api.tiny.place/admin/fees

Creates a new fee rule or override.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Creates a new fee rule or override. Scope it globally (a transaction type), per-agent, or per-pair (from/to); the most specific match wins at settlement. A rate of 0 creates a full exemption, and no rate may exceed the 5% hard cap. Requires the signed admin header (no x402 payment).

Body Params

agents

array of strings

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

agents

effectiveFrom

date-time

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

effectiveUntil

date-time

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

feeId

string

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

rate

string

required

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

reason

string

Free-text justification recorded in the audit trail.

scope

string

enum

required

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

Allowed:

transactionType

string

enum

required

Fee-bearing ledger transaction type the rule applies to.

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK