Get Commission Statement

📘 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 get only your own statements, not the statements of your sub-partners.

<details> <summary>Usage</summary>

Reconcile your commission line by line. This endpoint gets one commission statement with its balances and line items, in any status.

lineItems groups the line items by category. Every category is present. A category with no line items is an empty array.

Category	Contains
merchantPayment	Commission you earn when a merchant pays an invoice
merchantPaymentReturn	Commission reversed when a merchant invoice payment is returned
affiliatePayment	Commission you earn when a sub-partner pays an invoice
affiliatePaymentReturn	Commission reversed when a sub-partner invoice payment is returned
revenueShare	Revenue share from merchant services
adjustment	Manual adjustments
startingBalance	Balance carried into the statement
payment	Commission payouts to your bank account

merchantPayment and merchantPaymentReturn include invoiceLineItems for every commission row you have on that invoice. affiliatePayment and affiliatePaymentReturn include only rows whose commission is paid to you. When the invoice is not found, invoiceLineItems is an empty array.

All amounts are amount objects with a decimal string and a currency. All dates use ISO 8601 with a UTC offset.

Balances can change until the statement is finalized. Until then, the response includes warnings.

</details>

get/v4/commissions/statement/{statementId}

Request

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

objectType'rcssCommissionStatementDetailReport' required

Always rcssCommissionStatementDetailReport.

statementIdstring uuid required

Statement ID.

status'open' | 'pending_approval' | 'approved' | 'finalized' required

Statement status. open: the period is in progress. pending_approval: the period has ended and the statement is under review. approved: approved for payout. finalized: closed; balances are final and the PDF is available.

periodStartstring date-time required

Start of the statement period.

periodEndstring date-time required

End of the statement period.

customerIdstring uuid required

ID of the partner's account in the commission statement service.

externalCustomerIdstring required

The partner ID, wrapped in periods.

warningsstring[]

Present only when the statement is not finalized.

Example response

{
  "statementId": "295c8c97-6a67-11f1-a03e-b2b9900f1245",
  "periodStart": "2026-06-01T00:00:00+00:00",
  "periodEnd": "2026-07-01T00:00:00+00:00",
  "externalCustomerId": ".1001.",
  "openingBalance": {
    "amount": "125.50",
    "currency": "USD"
  },
  "closingBalance": {
    "amount": "125.50",
    "currency": "USD"
  },
  "lineItems": {
    "affiliatePayment": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "invoiceNumber": "262380655",
          "affiliateId": "2002",
          "invoiceLineItems": [
            {
              "description": "Monthly Fee",
              "processorType": "cc",
              "processorName": "TSYS - EMV",
              "merchantProcessorName": "Main MID",
              "quantity": "1.00000000",
              "yourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalYourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "resalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalResalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalCommission": {
                "amount": "125.50",
                "currency": "USD"
              }
            }
          ],
          "invoiceDate": "2026-06-01T04:00:00+00:00",
          "invoiceAmount": {
            "amount": "125.50",
            "currency": "USD"
          }
        }
      }
    ],
    "merchantPayment": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "invoiceNumber": "262380581",
          "merchantId": "1001",
          "merchantName": "Example Merchant LLC",
          "invoiceLineItems": [
            {
              "description": "Monthly Fee",
              "processorType": "cc",
              "processorName": "TSYS - EMV",
              "merchantProcessorName": "Main MID",
              "quantity": "1.00000000",
              "yourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalYourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "resalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalResalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalCommission": {
                "amount": "125.50",
                "currency": "USD"
              }
            }
          ],
          "invoiceDate": "2026-06-01T04:00:00+00:00",
          "invoiceAmount": {
            "amount": "125.50",
            "currency": "USD"
          }
        }
      }
    ],
    "merchantPaymentReturn": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "invoiceNumber": "262380581",
          "merchantId": "1001",
          "merchantName": "Example Merchant LLC",
          "invoiceLineItems": [
            {
              "description": "Monthly Fee",
              "processorType": "cc",
              "processorName": "TSYS - EMV",
              "merchantProcessorName": "Main MID",
              "quantity": "1.00000000",
              "yourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalYourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "resalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalResalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalCommission": {
                "amount": "125.50",
                "currency": "USD"
              }
            }
          ],
          "invoiceDate": "2026-06-01T04:00:00+00:00",
          "invoiceAmount": {
            "amount": "125.50",
            "currency": "USD"
          }
        }
      }
    ],
    "affiliatePaymentReturn": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "invoiceNumber": "262380655",
          "affiliateId": "2002",
          "invoiceLineItems": [
            {
              "description": "Monthly Fee",
              "processorType": "cc",
              "processorName": "TSYS - EMV",
              "merchantProcessorName": "Main MID",
              "quantity": "1.00000000",
              "yourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalYourCost": {
                "amount": "125.50",
                "currency": "USD"
              },
              "resalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalResalePrice": {
                "amount": "125.50",
                "currency": "USD"
              },
              "totalCommission": {
                "amount": "125.50",
                "currency": "USD"
              }
            }
          ],
          "invoiceDate": "2026-06-01T04:00:00+00:00",
          "invoiceAmount": {
            "amount": "125.50",
            "currency": "USD"
          }
        }
      }
    ],
    "startingBalance": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "description": "Balance carried forward"
        }
      }
    ],
    "adjustment": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "description": "Manual adjustment"
        }
      }
    ],
    "payment": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "paymentAmountAttempted": {
            "amount": "125.50",
            "currency": "USD"
          },
          "transactionId": "10987654321",
          "paymentStatus": "success",
          "accountNumber": "1*****6789",
          "routingNumber": "021000021",
          "processorResponseCode": "100"
        }
      }
    ],
    "revenueShare": [
      {
        "date": "2026-06-17T16:11:24+00:00",
        "amount": {
          "amount": "125.50",
          "currency": "USD"
        },
        "metaData": {
          "affiliateId": "1001",
          "merchantNumber": "1001",
          "grossIncome": {
            "amount": "125.50",
            "currency": "USD"
          },
          "downstreamShare": {
            "amount": "125.50",
            "currency": "USD"
          }
        }
      }
    ]
  },
  "warnings": [
    "This statement is not finalized and balances may not be accurate.",
    "Statement data is subject to change until finalized."
  ]
}

Changes

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