Get Saved Commission Summary Report
<details> <summary>Usage</summary>📘 Commission summary
Your API key must belong to a partner user with the commission permission.
Page through a large commission summary without rebuilding it. This endpoint gets a page of a report you created with POST /v4/commission_reports/summary. Use offset and maxResults to choose the page. The response returns those two fields as strings, exactly as you sent them.
A report is saved for 24 hours, and only the user who created it can get it. If the report has expired, does not exist, or belongs to another user, the endpoint returns 404. Create a new report to continue.
Use hasMore to decide whether to request another page. To get another page, call this endpoint with reportId, offset, and maxResults. An offset past the end of the report returns 422.
</details>Request
- Base URLhttps://sandbox.nmi.com/api
- URLhttps://sandbox.nmi.com/api/v4/commission_reports/summary/{reportId}
- AuthAPI key in header Authorization
Path parameters
reportId from Create Commission Summary Report.
Query parameters
Number of results to skip.
Maximum number of results to return.
Headers
Your v4 API key that was generated in the Partner portal.
Response
A page of the report.
Example response
{
"reportId": 456,
"results": [
{
"merchant_id": "3001",
"merchant_name": "Example Merchant LLC",
"statement_id": "262380581",
"gross_revenue": {
"amount": "125.50",
"currency": "USD"
},
"cost": {
"amount": "125.50",
"currency": "USD"
},
"sell_rate": {
"percent": "2.50"
},
"buy_rate": {
"percent": "2.50"
},
"net_revenue": {
"amount": "125.50",
"currency": "USD"
},
"merchant_processor_id": "5501",
"merchant_processor_name": "Main MID",
"processor_id": "tsys",
"fee_type_id": "3",
"billed_quantity": "1.00",
"pay_commission_to_affiliate": "1"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.