Skip to main content
GET
Get developer-fee revenue

What this endpoint does

Returns developer-fee revenue earned by the current tenant account.

When to use it

Use it to build fee-revenue reporting: group by period (day, week, or month; default day), and optionally bound the window with from/to or filter by asset. Amounts are decimal strings with an explicit asset code. Pair it with GET /v1/invoices to reconcile the developer-fee credits netted off each invoice.

Before you call

Authenticate with an API key that can read fees — a scoped key must include fees:read (fees:write implies it); this family also covers revenue and invoices.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

Revenue appears according to completed conversion and billing records; unsettled transfers may not yet contribute.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Revenue and invoices for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Query Parameters

period
enum<string>
Available options:
day,
week,
month
from
string<date-time>
to
string<date-time>
asset
string
counterpartyId
string

Response

The revenue report for the requested window.

period
enum<string>
required
Available options:
day,
week,
month
from
string | null
required
to
string | null
required
scope
enum<string>
required
Available options:
admin,
counterparty
totals
object[]
required
byAsset
object[]
required
byCounterparty
object[]
required
series
object[]
required
generatedAt
string<date-time>
required