Get Sub-Affiliate List

post

https://sandbox.nmi.com/api/v4/affiliates/reports

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.

Usage

This is a query to get all sub-affiliate accounts under your partner account.

Body Params

maxResults

string

required

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

ids

array of strings

An array of merchant ids.

ids

parentAffiliateId

string

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

string

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.

offset

string

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

Headers

Content-Type

string

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).

Authorization

string

required

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

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success