Gateway Features
Billing & Commission

List Commission Statements

📘 Commission statements

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>

Find the statement you need, then get its details, report, or PDF. This endpoint lists the commission statements for the partner account that owns your API key. You have one statement per period, and the current period has an open statement.

Use the statementId of a result with:

  • GET /v4/commissions/statement/{statementId} for balances and line items, in any status.
  • GET /v4/commissions/report/{statementId}/xlsx or /csv for the commission report, in any status, including before the statement is finalized.
  • GET /v4/commissions/statement/{statementId}/pdf for the statement PDF, only after the statement is finalized.

closingBalance is null until the period closes.

</details>
get/v4/commissions/statements

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v4/commissions/statements
  • Auth
    API key in header Authorization

Headers

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Response

The partner's statements.

objectType'rcssCommissionStatementsReport' required

Always rcssCommissionStatementsReport.

Example response

{
  "results": [
    {
      "startingBalance": {
        "amount": "125.50",
        "currency": "USD"
      },
      "closingBalance": {
        "amount": "125.50",
        "currency": "USD"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.