Skip to content

Commit a830d43

Browse files
feat: add platform fee rules API endpoints and documentation
Introduce a complete CRUD API for platform-configurable fee markup, enabling platforms to define per-transaction-type fees that layer on top of Lightspark and counterparty fees. New endpoints: - POST /fee-rules — create a fee rule (one per transaction type) - GET /fee-rules — list all fee rules with optional filters - GET /fee-rules/{feeRuleId} — retrieve a single rule - PATCH /fee-rules/{feeRuleId} — partial update (amounts, enabled) - DELETE /fee-rules/{feeRuleId} — remove a rule - GET /fee-rules/report — monthly aggregated fee revenue New schemas: - FeeRule, FeeTransactionType, FeeRuleType - FeeRuleCreateRequest, FeeRulePatchRequest - FeeReport, FeeReportLine Extended existing schemas: - OutgoingRateDetails and IncomingRateDetails gain platform fee fields (platformFixedFee, platformVariableFeeRate, platformVariableFeeAmount) so quotes and transactions surface the platform markup alongside Lightspark fees. New error codes: - INVALID_FEE_RULE (400), INVALID_MONTH_FORMAT (400) - FEE_RULE_NOT_FOUND (404), FEE_RULE_EXISTS (409) Documentation: - Shared snippet with guide, cURL examples, and fee layering table - Wrapper pages in all four use-case tabs (Payouts, Ramps, Rewards, Global P2P) under Platform Tools Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 45cff71 commit a830d43

24 files changed

Lines changed: 2401 additions & 486 deletions

mintlify/docs.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
{
102102
"group": "Platform Tools",
103103
"pages": [
104+
"payouts-and-b2b/platform-tools/fee-rules",
104105
"payouts-and-b2b/platform-tools/webhooks",
105106
"payouts-and-b2b/platform-tools/sandbox-testing",
106107
"payouts-and-b2b/platform-tools/postman-collection"
@@ -146,6 +147,7 @@
146147
{
147148
"group": "Platform Tools",
148149
"pages": [
150+
"ramps/platform-tools/fee-rules",
149151
"ramps/platform-tools/webhooks",
150152
"ramps/platform-tools/sandbox-testing",
151153
"ramps/platform-tools/postman-collection"
@@ -189,6 +191,7 @@
189191
{
190192
"group": "Platform Tools",
191193
"pages": [
194+
"rewards/platform-tools/fee-rules",
192195
"rewards/platform-tools/webhooks",
193196
"rewards/platform-tools/sandbox-testing",
194197
"rewards/platform-tools/postman-collection"
@@ -237,6 +240,7 @@
237240
{
238241
"group": "Platform Tools",
239242
"pages": [
243+
"global-p2p/platform-tools/fee-rules",
240244
"global-p2p/platform-tools/webhooks",
241245
"global-p2p/platform-tools/sandbox-testing",
242246
"global-p2p/platform-tools/postman-collection",
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Platform fee rules"
3+
description: "Configure the markup your platform charges customers per transaction type"
4+
icon: "/images/icons/settings-gear2.svg"
5+
"og:image": "/images/og/og-global-p2p.png"
6+
---
7+
8+
import PlatformFeeRules from '/snippets/platform-fee-rules.mdx';
9+
10+
<PlatformFeeRules />

0 commit comments

Comments
 (0)