Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Gateway Features
Affiliates

Get Sub-Affiliate List

❗️ 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 is a query to get all sub-affiliate accounts under your partner account. </details>
post/v4/affiliates/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

maxResultsstring required

Number of max results, any integer number from 1 to 1000.

idsstring[]

An array of merchant ids.

parentAffiliateIdstring

An affiliate id. Only merchants under this affiliate will be returned, rather than the full tree.

searchstring

Performs a search on this text as a case-insensitive search on any of the following: email, company name, first and last name, phone number, external id, or username.

offsetstring

Like all reports and search endpoints, you can specify the offset, which is the start point for the responses.

Response

Success

objectTypestring

Type of the object, in this case, 'report'.

reportIdinteger

ID for the report.

offsetinteger nullable

Offset value for pagination, or null if not used.

maxResultsinteger

Maximum number of results per page.

totalResultsinteger

Total number of results available for the report.

hasMoreboolean

Indicates if there are more results available beyond the current page.