List merchants

Lists all merchants associated with the authenticated entity. The request must include a valid API key with appropriate permissions. This endpoint is useful for managing multiple merchants and their configurations.

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

Optional filter to retrieve merchants with a specific ID. Useful for filtering merchants when managing multiple merchants

string

Optional filter to retrieve merchants with a specific name. Useful for filtering merchants when managing multiple merchants

string

Optional filter to retrieve merchants with a specific reference ID. Useful for filtering merchants when managing multiple merchants

double

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

double

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

string

Optional sorting parameter to specify the field to sort the results by. Valid options are "dateCreated", "merchantId", "merchantName", and "merchantRefId". Default is "dateCreated".

string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Responses

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