Skip to main content
POST
/
summary-report
/
revenue
Fetch revenue summary for a timeframe
curl --request POST \
  --url https://operator-financial-reporting.staging.ezprk.dev/summary-report/revenue \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "operatorId": 12345,
  "startDate": "2026-01-14",
  "endDate": "2026-01-15"
}
'
{
  "transmissionDateTime": "2026-01-15T10:30:00",
  "operatorId": 12345,
  "startDate": "2026-01-01T00:00:00",
  "endDate": "2026-01-07T23:59:59",
  "revenue": [
    {
      "paymentType": "CARD",
      "totalAmount": {
        "amount": 1234.56,
        "currency": "USD"
      }
    }
  ]
}

Authorizations

​
X-Authorization
string
header
required

For the header value, use the format: Bearer YOUR-JWT-TOKEN. You can get the token from the auth/v1 endpoint.

Body

application/json

Request body containing parameters for report generation

Request parameters for revenue summary

​
operatorId
integer<int64>
​
startDate
string<date>
​
endDate
string<date>

Response

200 - application/json

Revenue summary successfully retrieved

Response containing revenue summary for a specific period

​
transmissionDateTime
string<date-time>

Date and time of report transmission

Example:

"2026-01-15T10:30:00"

​
operatorId
integer<int64>

Operator identifier

Example:

12345

​
startDate
string<date-time>

Start date of the reporting period

Example:

"2026-01-01T00:00:00"

​
endDate
string<date-time>

End date of the reporting period

Example:

"2026-01-07T23:59:59"

​
revenue
object[]

List of revenue items grouped by payment type and currency