GetMerchantsContinuationInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input parameters for retrieving a paged list of merchants using continuation-token-based pagination. Supports filtering, sorting, and options to include soft-deleted or inactive merchants.
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.
Fields
| 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:
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: This body has no documented fields. | ||||||||||||||||||
This model has no documented fields.