Gateway Features
Billing & Commission

Export Commission Statement (XLSX)

📘 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 export only your own statements.

<details> <summary>Usage</summary>

Review or reconcile your commission in a spreadsheet. This endpoint downloads the commission report for a statement as an Excel (.xlsx) workbook. The report is available in any status. Sheets, in order:

  • Summary: Statement ID, Status, Customer ID, External Customer ID (your numeric partner ID), Period Start, Period End, Opening Balance, Balance, Generated At. Dates are YYYY-MM-DD. Generated At is the UTC date.
  • Affiliate Payment, Merchant Payment, Merchant Payment Return, Affiliate Payment Return: one row per fee. A payment with no fee breakdown is one row. Return sheets omit Your Cost and Resale Price.
  • Third Party Commissions: one row per revenue share entry.
  • Adjustment, Starting Balance, Payment.
  • All Lines: one row per line item on the statement.

Balances can change until the statement is finalized.

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

</details>
get/v4/commissions/report/{statementId}/xlsx

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v4/commissions/report/{statementId}/xlsx
  • 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 statement as an Excel workbook.

Changes

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