NMnmi
Gateway Features
Billing & Commission

Download Commission Statement PDF

📘 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. You can download only your own statements.

<details> <summary>Usage</summary>

Get the final statement for your records. This endpoint downloads the commission statement PDF.

The PDF exists only when the status is finalized. For any other status the endpoint returns 403. Before finalization, use the commission report: GET /v4/commissions/report/{statementId}/xlsx or /csv. The report is available in any status.

On success the response is the PDF file. On an error the response is JSON.

</details>
get/v4/commissions/statement/{statementId}/pdf

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v4/commissions/statement/{statementId}/pdf
  • Auth
    API key in header Authorization

Path parameters

statementIdstring uuid required

Statement ID, from List Commission Statements.

Headers

Authorizationstring required

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

Response

The finalized statement as a PDF.

Changes

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