Lists the active merchants under the calling reseller and every reseller beneath it.

GET /api/merchants/reseller-scope deprecated

Requires: Merchants.Merchants, merchant scope.

The scope is resolved for each call rather than taken from the caller's sign-in, so a merchant created since the caller signed in appears without a new sign-in, and the route behaves the same while impersonating. A caller that is not a reseller receives an empty page. The request's `Filter`, `MaxResultCount` and `ContinuationToken` are honoured. Its `ResellerId` is ignored: the scope is always the caller's own, never one the caller names.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a GetMerchantsContinuationInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/merchants/reseller-scope" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "processorId": "",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {}
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "processorId": "",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {}
}
'@

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/merchants/reseller-scope' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MerchantsApi } from '@winkpg/winkpg-api';

const api = new MerchantsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.merchantsGetResellerScopeMerchants({
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "processorId": "",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": false,
  "includeInactive": false,
  "includeApproxTotalCount": false,
  "sorting": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/merchants/reseller-scope', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "processorId": "",
    "filter": {},
    "maxResultCount": 0,
    "continuationToken": "",
    "includeDeleted": false,
    "includeInactive": false,
    "includeApproxTotalCount": false,
    "sorting": {}
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MerchantsApi(config);
var body = JsonSerializer.Deserialize<GetMerchantsContinuationInput>("""
    {
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "processorId": "",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {}
    }
    """);

var result = await api.MerchantsGetResellerScopeMerchantsAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/merchants/reseller-scope");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "processorId": "",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": false,
      "includeInactive": false,
      "includeApproxTotalCount": false,
      "sorting": {}
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MerchantsApi(client)
    body = winkpg_api.GetMerchantsContinuationInput.from_dict({
      "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "processorId": "",
      "filter": {},
      "maxResultCount": 0,
      "continuationToken": "",
      "includeDeleted": False,
      "includeInactive": False,
      "includeApproxTotalCount": False,
      "sorting": {}
    })
    result = api.merchants_get_reseller_scope_merchants(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "resellerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "processorId": "",
  "filter": {},
  "maxResultCount": 0,
  "continuationToken": "",
  "includeDeleted": False,
  "includeInactive": False,
  "includeApproxTotalCount": False,
  "sorting": {}
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/merchants/reseller-scope",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`resellerId` required	string (uuid)	The reseller identifier whose merchants will be retrieved. nullable
`processorId` required	string	Optional processor identifier to filter merchants that have a processor profile with a matching processor ID (e.g., "fiserv", "tsys", "vericheck"). nullable
`filter` required	all of FilterGroup	Gets or sets the filter group to apply when querying merchants.
`maxResultCount` required	integer (int32)	The maximum number of items to return in a single page.
`continuationToken` required	string	Gets or sets the continuation token from a previous query for cursor-based pagination. nullable
`includeDeleted` required	boolean	Gets or sets a value indicating whether to include soft-deleted merchants in the results. Defaults to `false`.
`includeInactive` required	boolean	Gets or sets a value indicating whether to include inactive merchants in the results. Defaults to `true`.
`includeApproxTotalCount` required	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before. nullable
`sorting` required	all of SortDescriptor	Gets or sets the sort descriptor that controls the ordering of the result set.

This request body has no documented fields.