Review Paginated Submerchants v2

Returns a paginated list of submerchants within a Backoffice tenant. This endpoint retrieves the same merchant data as merchant/paginated, including merchant profile information, users, and more, but with an updated paginated response. The tenantId is a required path parameter. Use the pageSize and currentPage query parameters to organize and navigate your result set. The default pageSize is 1000. See the totalRequestedDataCount, currentPage, pageSize, and totalPages values at the end of each page of the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier, or name, of a Backoffice tenant.

string
required

Specify v2 as the version within the path to utilize pagination options.

Query Params
boolean

This parameter is not currently supported.

int32

Use this parameter to navigate between pages of results.

int32

Use this parameter to specify the number of results per page. The default pageSize is 1000.

string
enum

A submerchant's account status.

Allowed:
DBAName
array of strings

A submerchant's doing business as name (DBA).

DBAName
LegalEntityName
array of strings

A submerchant's legal entity name.

LegalEntityName
Mid
array of strings

A submerchant's merchant identification number (MID) provided by their payments processor.

Mid
Id
array of int32s

A submerchant's Backoffice identification number.

Id
Cobrand
array of strings

The New Accounts cobrand where the submerchant's merchant application was submitted.

Cobrand
Location
array of strings

A submerchant's location.

Location
MerchantCategoryCode
array of strings

A submerchant's merchant category code (MCC).

MerchantCategoryCode
string
enum

A submerchant's funding configration.

Allowed:
int32

A Backoffice user's identification number. Use this parameter to retrieve a list of submerchants the userID has access to.

Responses

404

Not Found

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json