NMnmi
Gateway Features
Billing & Commission

Export Commission Statement (CSV)

📘 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>

Load your commission into your own reporting or accounting tools. This endpoint downloads the commission report for a statement as a ZIP archive of CSV files. The report is available in any status.

FileContents
merchant_payment.csvMerchant invoice payments, one row per fee
merchant_payment_return.csvReturned merchant invoice payments, one row per fee
affiliate_payment.csvSub-partner invoice payments, one row per fee
affiliate_payment_return.csvReturned sub-partner invoice payments, one row per fee
third_party_commissions.csvRevenue share, one row per entry
adjustment.csvManual adjustments
starting_balance.csvStarting balance
payment.csvCommission payouts
all_lines.csvEvery line item on the statement, one row each
manifest.jsonStatement identifiers, period, balances, and the record count of each file

Every CSV file is always present in the archive. When there are no entries of a certain line item type, only the header is present in the file.

manifest.json contains statement_id, status, customer_id, external_customer_id (your gateway partner ID), period_start and period_end (YYYY-MM-DD), opening_balance, balance, generated_at (YYYY-MM-DD, UTC), and files (name, record_count).

Balances can change until the statement is finalized.

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

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

Request

  • Base URL
    https://sandbox.nmi.com/api
  • URL
    https://sandbox.nmi.com/api/v4/commissions/report/{statementId}/csv
  • 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

A ZIP archive of CSV files for the statement.

Changes

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