List Merchants
Returns a paginated list of merchants under a specific partner. This endpoint is only available for partners at the Master Merchant level.
Endpoint
GET /Partners/{id}/merchants
Authentication
X-Api-Key: {adminApiKey}Path parameters
id
string
Yes
The partnerId of the Master Merchant partner whose merchants you want to list
Query parameters
Search
string
No
Search by company name
SortBy
string
No
Field to sort by. Supported values: Created, Updated, CompanyName
SortDirection
string
No
asc or desc
Page
integer
No
Page number, zero-indexed. Defaults to 0
PageSize
integer
No
Number of results per page. Defaults to 50, max 100
Request headers
X-Api-Key
{adminApiKey}
Accept
application/json
Example request
Successful response — 200
The response is a paginated wrapper containing an array of merchant objects.
Response fields
data
Array of merchant objects
data[].merchant
Core merchant record — see Get Merchant for full field reference
data[].details
Extended KYB details object, or null if not available
total
Total number of merchants matching the query
page
Current page number, zero-indexed
Error responses
401
Missing or invalid API key
403
Authenticated but not permitted to list merchants for this partner, or partner is not a Master Merchant
404
Partner {id} does not exist or is not visible to your key
Best practices
Confirm the partner is at the Master Merchant level before calling this endpoint — other partner types will return a 403
Use
Status=activeto filter to merchants ready for production trafficUse
Searchto locate a specific merchant by company name rather than fetching all pagesStore
totalto drive pagination logic in your UI
Related pages
Last updated