Skip to main content
GET
Get Commissions
Retrieve a paginated list of commissions earned from your referrals. Filter by date range or currency.
Broker activation is required. Broker accounts are activated by the Rolla admin team — you cannot activate a broker account yourself through the API. Once your business has been activated as a broker by Rolla, all broker endpoints become available. Until then, all requests will return a 403 Forbidden error. Contact support@rolla.xyz to request broker activation.

Example Request

Query Parameters

Commissions are returned newest first. Every amount is an integer in the currency’s smallest unit: commission_amount is in the smallest unit of commission_currency, source_amount of source_currency, and destination_amount of destination_currency.

Example Response

In the row above the broker earned USD 15.50 on a USD 1,000 swap into NGN at a rate of 1,480 against a base rate of 1,475.
swap_transaction is null for a commission with no underlying swap on record, and exchange_rate, base_rate, source_amount and destination_amount are null when the pricing detail was not captured. Rows also carry meta, transaction and referredBusiness objects holding internal pricing detail; treat them as informational and do not depend on their contents.
Use the startDate and endDate filters to generate commission reports for specific periods. Both accept a date (2024-01-01) or a full ISO 8601 timestamp, and are matched against created_at.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
Example:

1

pageSize
integer
default:20

Results per page

Required range: 1 <= x <= 100
Example:

20

startDate
string

Only commissions earned on or after this date (date or ISO 8601 timestamp)

Example:

"2024-01-01"

endDate
string

Only commissions earned on or before this date (date or ISO 8601 timestamp)

Example:

"2024-01-31"

currency
string

Filter by commission currency, uppercase, 3 or 4 letters

Required string length: 3 - 4
Pattern: ^[A-Z]+$
Example:

"USD"

referredBusinessId
string<uuid>

Only commissions earned from this referred business

Example:

"d4e5f6a7-b8c9-4123-9def-456789012345"

Response

Commissions fetched successfully

status
integer
required
Example:

200

message
string
required
Example:

"Commissions fetched successfully"

success
boolean
required
Example:

true

data
object
required