get

api.monogoto.io/v1/reports/payments

Deprecated endpoint

This endpoint will be removed in a future version. Migrate to the recommended replacement.

Get Payment Reports

Scopes

payments:read

Rate limited

60 reqevery 1 minute·keyed byUser ID

Deprecated. Payment reports have moved to their own surface — use GET /v1/payment-reports (listPaymentReports). This route is retained for existing integrations; it will be removed after a deprecation window.

Retrieve a paginated list of the caller's payment reports (soft-deleted reports excluded), newest first by default. Same data as GET /v1/payment-reports, in the legacy shape: the list is under reports, each report's id is _id, and each carries description: PaymentReport.

Parameters

Query

pageinteger

optional

Page number for pagination (defaults to 1).

Default: 1

limitinteger

optional

Number of items per page (defaults to 20, maximum 100).

Default: 20

sort_bystring

optional

Column to sort on. Defaults to created_at.

enum:created_atupdated_atdate_createdfrom_dateto_datestatusgroupgroup_namecosttotal_costtotal_datacurrencycurrency_symbolactiveid

sort_directionstring

optional

Sort direction.

enum:ascdesc

start_timedate-time

optional

Only reports created at or after this time (ISO 8601). Must be sent together with end_time and must not be after it (400 otherwise). There is no maximum range.

end_timedate-time

optional

Only reports created at or before this time (ISO 8601). Must be sent together with start_time.

periodstring

optional

Predefined creation-time window, used only when start_time/end_time are absent. With no date parameter at all, reports of every date are listed.

enum:todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_months

groupstring

optional

Filter by group name (contains match).

coststring

optional

Filter by total cost (contains match).

currencystring

optional

Filter by currency code.

enum:USDCUSD

activestring

optional

Filter by active status.

enum:truefalse

total_datastring

optional

Filter by total data (contains match).

statusstring

optional

Filter by report status.

enum:DraftIn-progressCompletedFailed

Responses

Payment reports retrieved successfully

application/json

object

status_codeinteger

required

HTTP status code

messagestring

required

Response message

dataobject

required

reportsarray[object]

optional

[ ]object

optional

A payment report in the legacy shape. Further stored fields may be present.

paginationobject

optional

totalnumber

required

Total number of records

pagenumber

required

Current page number

limitnumber

required

Number of records per page

request_idstring

required

Unique request ID for tracking

Example

{
  "status_code": 200,
  "message": "Success",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "reports": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "description": "PaymentReport",
        "community": "507f1f77bcf86cd799439012",
        "status": "Completed",
        "is_deleted": false,
        "date_created": "2026-01-15T12:00:00.000Z",
        "from_date": "2026-01-01T00:00:00.000Z",
        "to_date": "2026-01-31T23:59:59.000Z",
        "group_id": "",
        "group_name": "All Groups",
        "total_data": "1.5 GB",
        "total_cost": "150.00",
        "currency_symbol": "USD",
        "active": "true",
        "report_file": "https://storage.example.com/reports/report-123.csv",
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:05:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 20
    }
  }
}

GET

Get Enriched NetFlow Data

/v1/netflow/enriched

GET

Get Network Diagram Summary

/v1/netflow/networkdiagram-summary

GET

Get Top Destinations

/v1/netflow/top-destinations

GET

Get Data Transfer

/v1/netflow/data-transfer

GET

Get Services

/v1/netflow/services

Was this page helpful?

curl -X GET 'https://api.monogoto.io/v1/reports/payments?page=1&limit=20&sort_by=created_at&sort_direction=desc&start_time=2026-01-01T00%3A00%3A00Z&end_time=2026-01-31T23%3A59%3A59Z&period=last_30_days&group=All%20Groups&currency=USD' \ -H 'Authorization: Bearer $TOKEN'

{ "status_code": 200, "message": "Success", "request_id": "550e8400-e29b-41d4-a716-446655440000", "data": { "reports": [ { "_id": "507f1f77bcf86cd799439011", "description": "PaymentReport", "community": "507f1f77bcf86cd799439012", "status": "Completed", "is_deleted": false, "date_created": "2026-01-15T12:00:00.000Z", "from_date": "2026-01-01T00:00:00.000Z", "to_date": "2026-01-31T23:59:59.000Z", "group_id": "", "group_name": "All Groups", "total_data": "1.5 GB", "total_cost": "150.00", "currency_symbol": "USD", "active": "true", "report_file": "https://storage.example.com/reports/report-123.csv", "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:05:00.000Z" } ], "pagination": { "total": 1, "page": 1, "limit": 20 } } }

Parameters

Query

pageinteger

optional

Page number for pagination (defaults to 1).

Default: 1

limitinteger

optional

Number of items per page (defaults to 20, maximum 100).

Default: 20

sort_bystring

optional

Column to sort on. Defaults to created_at.

enum:created_atupdated_atdate_createdfrom_dateto_datestatusgroupgroup_namecosttotal_costtotal_datacurrencycurrency_symbolactiveid

sort_directionstring

optional

Sort direction.

enum:ascdesc

start_timedate-time

optional

Only reports created at or after this time (ISO 8601). Must be sent together with end_time and must not be after it (400 otherwise). There is no maximum range.

end_timedate-time

optional

Only reports created at or before this time (ISO 8601). Must be sent together with start_time.

periodstring

optional

Predefined creation-time window, used only when start_time/end_time are absent. With no date parameter at all, reports of every date are listed.

enum:todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_months

groupstring

optional

Filter by group name (contains match).

coststring

optional

Filter by total cost (contains match).

currencystring

optional

Filter by currency code.

enum:USDCUSD

activestring

optional

Filter by active status.

enum:truefalse

total_datastring

optional

Filter by total data (contains match).

statusstring

optional

Filter by report status.

enum:DraftIn-progressCompletedFailed

Responses

Payment reports retrieved successfully

application/json

object

status_codeinteger

required

HTTP status code

messagestring

required

Response message

dataobject

required

reportsarray[object]

optional

[ ]object

optional

A payment report in the legacy shape. Further stored fields may be present.

paginationobject

optional

totalnumber

required

Total number of records

pagenumber

required

Current page number

limitnumber

required

Number of records per page

request_idstring

required

Unique request ID for tracking

Example

{
  "status_code": 200,
  "message": "Success",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "reports": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "description": "PaymentReport",
        "community": "507f1f77bcf86cd799439012",
        "status": "Completed",
        "is_deleted": false,
        "date_created": "2026-01-15T12:00:00.000Z",
        "from_date": "2026-01-01T00:00:00.000Z",
        "to_date": "2026-01-31T23:59:59.000Z",
        "group_id": "",
        "group_name": "All Groups",
        "total_data": "1.5 GB",
        "total_cost": "150.00",
        "currency_symbol": "USD",
        "active": "true",
        "report_file": "https://storage.example.com/reports/report-123.csv",
        "created_at": "2026-01-15T12:00:00.000Z",
        "updated_at": "2026-01-15T12:05:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 20
    }
  }
}

Get Payment Reports

Parameters

Responses

Related

Get Payment Reports

Parameters

Responses

Related