List merchants

Retrieve a list of merchants accessible to the authenticated user. Returns merchants where the current user is associated as a sales officer, sales partner, or distributor client.

Query parameters

limitintegerOptional>=1<=1000Defaults to 100

Maximum number of merchants to return (default 100, max 1000)

offsetintegerOptional>=0Defaults to 0

Number of merchants to skip for pagination (default 0)

merchant_statusstringOptional
Filter by merchant status
platformenumOptional
Filter by platform
Allowed values:
rep_codestringOptional
Filter by representative code

Response

Merchants retrieved successfully
itemslist of objects or null
Array of merchant records
hasMoreboolean or null
Whether there are more merchants available
limitinteger or null
The limit parameter used for this request
offsetinteger or null
The offset parameter used for this request
countinteger or null
Number of merchants returned in this response

Errors