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

GET /api/merchants/reseller-scope deprecated

Requires: Merchants.Merchants, merchant scope.

Requires API key scope: admin (Administration)

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.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

resellerId required

string (uuid)

The reseller identifier whose merchants will be retrieved. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

filter required

FilterGroup FilterGroup

Gets or sets the filter group to apply when querying merchants.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of FilterGroup:

Field Type Description

logic required

FilterLogic FilterLogic

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`And`
`Or`

rules required

array of FilterRule array of FilterRule

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

groups required

array of FilterGroup array of FilterGroup

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

maxResultCount required

integer (int32)

The maximum number of items to return in a single page.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

continuationToken required

string

Gets or sets the continuation token from a previous query for cursor-based pagination. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includeDeleted required

boolean

Gets or sets a value indicating whether to include soft-deleted merchants in the results. Defaults to `false`.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

includeInactive required

boolean

Gets or sets a value indicating whether to include inactive merchants in the results. Defaults to `true`.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sorting required

SortDescriptor SortDescriptor

Gets or sets the sort descriptor that controls the ordering of the result set.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of SortDescriptor:

Field Type Description

field required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

descending required

boolean

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This request body has no documented fields.

Responses

200 OK

Body: ContinuationPagedResultDtoOfMerchantDto ContinuationPagedResultDtoOfMerchantDto Each item has these fields.

Field Type Description

items required

array of MerchantDto array of MerchantDto

The items returned for this page. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each MerchantDto:

Field Type Description

extraProperties required

object

nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Indicates whether this entity has been deleted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deleterId required

string (uuid)

The ID of the user who deleted this entity, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deletionTime required

string (date-time)

The date and time when this entity was deleted, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

createdFromTemplateId required

string (uuid)

The template this record was created from, or `null` for one started blank. Set by the create-from-template path and by the add/edit page's Load Template action when the record is saved. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Gets or sets the display name of the merchant. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

Gets or sets the concurrency stamp used for optimistic concurrency control. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

tenantId required

string (uuid)

Gets the tenant identifier for multi-tenancy isolation. nullableread only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

resellerId required

string (uuid)

Gets or sets the unique identifier of the reseller that owns this merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

resellerName required

string

Gets or sets the display name of the owning reseller. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

entityVersion required

integer (int32)

Gets the entity version number, incremented on each update for optimistic concurrency. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customIdentifier required

string

Gets or sets an optional custom identifier assigned to the merchant by the reseller or integrator. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dba required

string

Gets or sets the "Doing Business As" (DBA) name for the merchant. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

legacyNumber required

integer (int64)

Gets the merchant's legacy numeric key, the integer identifier the v1 API addresses merchants by (its `MerchantKey`). Server-owned and stamped once at create; null on merchants written before the field existed until the v1 data migration back-fills them. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

mcc required

string

Gets or sets the four-character ISO 18245 Merchant Category Code identifying the merchant's industry. Null on legacy merchants that have not yet been backfilled; the merchant grid and detail view surface a warning indicator in that case so internal staff can address it. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isTest required

boolean

Gets or sets a value indicating whether this merchant is a test account used for non-production transactions.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

environment required

MerchantEnvironment MerchantEnvironment

Gets or sets the merchant's lifecycle environment.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Sandbox`	The merchant transacts against the processor's test host. No live money moves. This is the fail-closed default for anything whose environment cannot be determined.
`PendingPromotion`	The merchant has requested promotion to production and is awaiting approval. It may not transact against any endpoint while in this state.
`Production`	The merchant transacts against the processor's live host. The only state that resolves a production endpoint.
`Suspended`	The merchant has been administratively suspended. It may not transact against any endpoint, live or test, until it is returned to another state.

planCode required

string

Gets or sets the plan this merchant is on, or `null` when it is on none. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

trialExpiresAt required

string (date-time)

Gets or sets when this merchant's trial ends, UTC, or `null` when it is not on a time-limited plan. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

trialExpiryWarnedThresholdDays required

integer (int32)

Gets or sets the most recent trial expiry reminder sent in the current trial window, as the number of days before `trialExpiresAt` it was sent at. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

processorMode required

MerchantProcessorMode MerchantProcessorMode

Gets or sets which processor a sandbox merchant's transactions route to. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Loopback`	Route to the merchant's loopback processor profile. The loopback contributor is synthetic and performs no external I/O, so a sandbox merchant in this mode can be exercised end to end without any processor credentials.
`ProcessorTest`	Route to a real processor profile, which the merchant's sandbox environment already pins to that processor's test host.

isActive required

boolean

Gets or sets a value indicating whether the merchant is currently active and able to process transactions.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

contactDetail required

MerchantContactDetail MerchantContactDetail

Gets or sets the merchant's contact details including addresses, phone numbers, and email.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

businessInfo required

MerchantBusinessInfo MerchantBusinessInfo

Gets or sets the merchant's business information such as currency, tax IDs, and industry codes.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

virtualTerminal required

VirtualTerminalSettings VirtualTerminalSettings

Gets or sets the virtual terminal field configuration for the merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

processing required

ProcessingSettingsDto ProcessingSettingsDto

Gets or sets the processing settings including duplicate checks, card verification, and processor profiles.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

features required

MerchantFeatureSettings MerchantFeatureSettings

Gets or sets the feature flags and capability settings for the merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

capabilities required

MerchantCapabilitiesDto MerchantCapabilitiesDto

Gets or sets the read-only, server-computed capability flags derived from the merchant's configuration (e.g., active processor profiles' enabled tenders). Intended for UI affordance decisions; not enforced at submit time. Populated by the AutoMapper profile on read; not accepted on Create/Update.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customFields required

array of CustomField array of CustomField

Gets or sets the collection of custom fields defined for the merchant. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

branding required

MerchantBranding MerchantBranding

Gets or sets the merchant-level branding configuration for receipts and customer-facing communications.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

accountUpdater required

AccountUpdaterSettingsDto AccountUpdaterSettingsDto

Gets or sets the account updater configuration for this merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantFlowConfig required

MerchantFlowConfig MerchantFlowConfig

Gets or sets the optional transaction flow configuration that controls how transactions are orchestrated for this merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billingAssignment required

MerchantBillingAssignment MerchantBillingAssignment

Gets or sets the billing plan assignment for this merchant. A null value means the merchant has no active billing plan and will be skipped by billing runs.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notes required

array of EntityNote array of EntityNote

Gets or sets operational notes attached to the merchant. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

saveWarnings required

array of MerchantSaveWarning array of MerchantSaveWarning

Non-blocking informational warnings produced by the most recent create/update of this merchant (e.g. international-AVS-on-US-only-surface advisories). `null` on read responses, populated (possibly with an empty list) on create/update responses, so clients can distinguish "this isn't a save response" (omitted from JSON via `WhenWritingDefault`) from "saved successfully with no warnings" (empty array). Not persisted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

volumeTrend required

array of number (double) array of

Metered transaction count per calendar month for this merchant, oldest to newest, as an activity trend. `null` on every response that does not populate it (which is all of them except the merchant list), so it is omitted from JSON entirely rather than serialized as null. Not persisted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

digitalWallets required

array of MerchantDigitalWallet array of MerchantDigitalWallet

Gets or sets the per-merchant digital wallet bindings (Apple Pay, Google Pay, …). At most one entry per `WalletProviderType`; each carries the master enable flag and a pointer to the `WalletProviderRegistration` row this merchant uses (platform-level or merchant-level). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

threeDSBindings required

array of MerchantThreeDSBinding array of MerchantThreeDSBinding

Gets or sets the per-merchant 3-D Secure provider bindings. At most one entry per `ThreeDSProviderType`; each carries the master enable flag, the policy mode, and the vendor credentials. The JWT secret is never populated on a read. It is stripped server-side before this DTO leaves the application service, so a caller sees null there whether or not one is stored. Sending null or an empty string back on a save keeps the stored secret; sending a value replaces it. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxBindings required

array of MerchantTaxBinding array of MerchantTaxBinding

Gets or sets the per-merchant tax provider bindings. At most one entry per provider name; each carries the master enable flag, whose provider account the lookups are billed to, and the provider's configuration values. Secret field values are never populated on a read. They are stripped server-side before this DTO leaves the application service, and each field reports `isConfigured` instead so an operator can tell a stored secret from an empty one. Sending null or an empty string back on a save keeps the stored secret; sending a value replaces it. A binding whose credential source is `Gateway` carries no values at all: the gateway's own provider credentials are never copied onto a merchant, and are resolved at lookup time instead. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

shippingBindings required

array of MerchantShippingBinding array of MerchantShippingBinding

Gets or sets the per-merchant shipping rate provider bindings. At most one entry per provider name; each carries the master enable flag, whose provider account the quotes are billed to, and the provider's configuration values. Secret field values are never populated on a read. They are stripped server-side before this DTO leaves the application service, and each field reports `isConfigured` instead so an operator can tell a stored secret from an empty one. Sending null or an empty string back on a save keeps the stored secret; sending a value replaces it. A binding whose credential source is `Gateway` carries no values at all: the gateway's own provider credentials are never copied onto a merchant, and are resolved at quote time instead. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentEncryptionBindings required

array of MerchantPaymentEncryptionBinding array of MerchantPaymentEncryptionBinding

Gets or sets the per-merchant payment encryption provider bindings. At most one entry per provider name; each carries the master enable flag, whose provider account the decryption calls are billed to, the provider's configuration values, and the key serial identifier table. Secret field values and key references are never populated on a read. They are stripped server-side before this DTO leaves the application service. Each field reports `isConfigured` and each key entry reports `isKeyReferenceConfigured` in their place, so an operator can tell a stored value from an empty one. Sending null or an empty string back on a save keeps the stored value; sending a value replaces it. A binding whose credential source is `Gateway` carries no field values at all: the gateway's own provider credentials are never copied onto a merchant, and are resolved at decryption time instead. Key entries are the merchant's either way, because a key serial identifier maps that merchant's own device fleet. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

promotedAt required

string (date-time)

When this merchant was promoted to `Production` through the promotion action, UTC. Null for a merchant that has never been promoted that way. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

promotedByUserId required

string (uuid)

The user who ran the promotion that stamped `promotedAt`, or null when the merchant has never been promoted through that action. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isLocked required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lockedAt required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lockedByUserId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lockedByUserName required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lockReason required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

nextContinuationToken required

string

Continuation token to use when requesting the next page. Null means no additional pages exist. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

approxTotalCount required

integer (int64)

An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pageItemCount required

integer (int32)

Convenience property for the number of items in this page. read only

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

retrievedAt required

string (date-time)

When the page was retrieved. Useful for diagnostics and cache behavior.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Merchants

The API reference isn't available right now

No such operation

This reference may be out of date

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

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication