📘 Commission summary

This endpoint is available only if your partner account has access to the commission statements. Your API key must belong to a partner user with the commission permission.

<details> <summary>Usage</summary>

See the commission you earned in a month, fee by fee, before the statement closes. This endpoint creates a commission summary for one month and returns the first page.

Each result is commission on a merchant fee. A fee is included when its commission was recorded in that month, posted to a statement, and set to show on the commission report. The invoice does not have to be paid. One fee can span more than one row when the quantity or the rate differs.

• month and year default to the current month and year on the gateway.
• maxResults is required, from 1 to 10000.
• offset defaults to 0. If you omit it, it is returned as null.

The report is saved for 24 hours. To get more pages, call GET /v4/commission_reports/summary/{reportId} with the reportId from the response.

Use hasMore to decide whether to request another page. An offset past the end of the report returns 422.

Result fields use snake_case. sell_rate and buy_rate are percent objects for percentage fees and amount objects for other fees. A percent has two decimal places: 2.50 means 2.50%.

If your partner account does not have access to the commission statements, you get a 422 response, not 403.

</details>

{
  "month": 6,
  "year": 2026,
  "maxResults": 100
}

{
  "reportId": 456,
  "results": [
    {
      "merchant_id": "3001",
      "merchant_name": "Example Merchant LLC",
      "statement_id": "262380581",
      "gross_revenue": {
        "amount": "125.50",
        "currency": "USD"
      },
      "cost": {
        "amount": "125.50",
        "currency": "USD"
      },
      "sell_rate": {
        "percent": "2.50"
      },
      "buy_rate": {
        "percent": "2.50"
      },
      "net_revenue": {
        "amount": "125.50",
        "currency": "USD"
      },
      "merchant_processor_id": "5501",
      "merchant_processor_name": "Main MID",
      "processor_id": "tsys",
      "fee_type_id": "3",
      "billed_quantity": "1.00",
      "pay_commission_to_affiliate": "1"
    }
  ]
}