Get monthly fee report

Retrieve an aggregated summary of platform fees collected during a specific month, broken down by transaction type. Covers only transaction-based fees that were collected in real time during settlement.

The report includes the total fees collected and a per-transaction-type breakdown with transaction counts.

GET /fee-rules/report

Get monthly fee report

cURL

curl --request GET \
  --url https://api.lightspark.com/grid/2025-10-13/fee-rules/report \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "month": "2026-02",
  "totalPlatformFeesCollected": 128450,
  "currency": "USD",
  "lines": [
    {
      "transactionType": "TRANSFER_OUT",
      "transactionCount": 245,
      "platformFeesCollected": 62500,
      "currency": "USD"
    },
    {
      "transactionType": "CROSS_BORDER_PAYOUT",
      "transactionCount": 97,
      "platformFeesCollected": 51300,
      "currency": "USD"
    },
    {
      "transactionType": "RAMP_OFF",
      "transactionCount": 58,
      "platformFeesCollected": 14650,
      "currency": "USD"
    }
  ]
}

Authorizations

Authorization · string · header · required

API token authentication using format <api token id>:<api client secret>

Query Parameters

month · string

Reporting month in YYYY-MM format. Defaults to the current month.

Pattern: ^\d{4}-\d{2}$

Example:

"2026-02"

Response

200

application/json

Successful operation

Monthly summary of platform fee revenue, broken down by transaction type. Covers fees collected in real time during transaction settlement within the specified month.

month · string · required

Reporting month in YYYY-MM format.

Pattern: ^\d{4}-\d{2}$

Example:

"2026-02"

totalPlatformFeesCollected · integer<int64> · required

Total platform fees collected across all transaction types in the smallest unit of the reporting currency (USD cents).

Required range: x >= 0

Example:

128450

currency · string · required

ISO 4217 currency code for the reporting currency. Currently always USD.

Example:

"USD"

lines · object[] · required

Per-transaction-type breakdown of collected fees

Show child attributes