v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Gateway Features

Billing & Commission

See Your Commission

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This will let you see what billing has occurred on merchants under your partner account </details>

post/v4/commission_reports/reports

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

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

Request body

monthstring required

Required. Month requested for the response.

yearstring required

Required. Year requested for the response.

offsetstring required

Required. "offset": 0 // Like all reports and search endpoints, you can specify the offset, which is the start point for the responses

maxResultsstring required

Required. Value must be between 1-1000.

Response

Success

objectType'serviceConfig'

The type of object that was returned as a result of the request.

reportIdnumber

The ID of the report.

offsetnumber

The first N skipped results.

maxResultsnumber

The max number results.

totalResultsnumber

The total number of results.

hasMoreboolean

If are there more results for the search.