Skip to main content
GET
Retrieve payout summary reports within the given date range

Retrieve Payout Summary by Date Range

This endpoint fetches payout summary records within a given date range, with pagination support.

Path Parameters

  • fromDate (string, required):
    The starting date (inclusive) for the date range filter.
    Format: yyyy-MM-dd HH:mm:ss
    • Example: 2025-01-01 00:00:00
    • The API will retrieve all payout summary records created on or after this date.
  • toDate (string, required):
    The ending date (inclusive) for the date range filter.
    Format: yyyy-MM-dd HH:mm:ss
    • Example: 2025-01-31 23:59:59
    • The API will retrieve all payout summary records created on or before this date.
📌 How it Works
If you specify a fromDate of 2025-01-01 00:00:00 and a toDate of 2025-01-31 23:59:59, the API will return all payout summary records that were created within this date range. The results will be paginated based on the provided query parameters.

Query Parameters

  • page (integer, optional, default: 0): The page number to fetch.
  • size (integer, optional, default: 10): The number of records per page.

Request Headers

  • User-Agent (string, optional): The User-Agent header, which is not mandatory.

Example Request

Authorizations

apiKey
string
header
required
X-HMAC-Signature
string
header
required
accountId
string
header
required

Headers

User-Agent
string

Path Parameters

fromDate
string<date-time>
required

Start date in format yyyy-MM-dd HH:mm:ss

toDate
string<date-time>
required

End date in format yyyy-MM-dd HH:mm:ss

Query Parameters

page
integer<int32>
default:0

Page number for pagination (default: 0)

size
integer<int32>
default:10

Number of records per page (default: 10)

Response

OK. Payout summary records retrieved successfully

status
string
message
string
response
object