Skip to main content
GET
/
broker
/
commissions
Get Commissions
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/broker/commissions \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Commissions retrieved successfully",
  "data": {
    "commissions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "currency": "<string>",
        "businessName": "<string>",
        "businessEmail": "jsmith@example.com",
        "transactionAmount": 123,
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}
Retrieve a paginated list of commissions earned from your referrals. Filter by date range or currency.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/broker/commissions?page=1&pageSize=20&currency=USD&startDate=2024-01-01&endDate=2024-01-31" \
  -H "X-API-Key: your_api_key_here"

​
Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
pageSizeintegerResults per page (default: 20, max: 100)
startDatestringStart date filter (YYYY-MM-DD)
endDatestringEnd date filter (YYYY-MM-DD)
currencystringFilter by 3-letter currency code (uppercase, e.g. USD)

​
Example Response

{
  "success": true,
  "message": "Commissions retrieved successfully",
  "data": {
    "commissions": [
      {
        "id": "e5f6a7b8-c9d0-1234-efgh-567890123456",
        "amount": 15.50,
        "currency": "USD",
        "businessName": "Acme Corp Ltd",
        "businessEmail": "contact@acmecorp.com",
        "transactionAmount": 1000,
        "created_at": "2024-01-20T14:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 45
    }
  }
}
Use the startDate and endDate filters to generate commission reports for specific periods.

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
pageSize
integer
default:20

Results per page (default: 20, max: 100)

Required range: 1 <= x <= 100
​
startDate
string<date>

Start date filter (YYYY-MM-DD)

​
endDate
string<date>

End date filter (YYYY-MM-DD)

​
currency
string

Filter by 3-letter currency code (uppercase)

Required string length: 3
Example:

"USD"

Response

Commissions retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Commissions retrieved successfully"

​
data
object