Get all Merchants

Returns paginated data for all of your merchants

Query Params
int32

Determines how many records will be returned per page.

int32

Returns data for the page given.

statuses[]
array of strings

Returns the merchant(s) with the given merchant status(es). Possible values: ACTIVE, PENDING, INACTIVE.

statuses[]
string

Filters merchants whose reference field holds the exact value specified.

boolean

Filters merchants who have a risk hold on their account.

ids[]
array of strings

Returns the merchant(s) with the given merchant id(s).

ids[]
string

Returns all merchants with the given email.

string

Returns all merchants with the given phone number.

string

Returns all merchants with the given name.

string

Returns all merchants with the given company name.

string

Returns all merchants in a given city.

string

Returns all merchants in a given state.

string

Returns all merchants in a given zip code.

string
enum

The property by which the results are sorted.

Allowed:
string
enum

The order in which the results are sorted.

Allowed:
Response

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