Skip to main content
GET
List merchants

Authorizations

Api-Key
string
header
required

Query Parameters

status
enum<string>

Filter by merchant status

Available options:
active,
inactive,
suspended

Search by merchant name or ID (case-insensitive)

Required string length: 1 - 256
Example:

"Acme"

cursor
string

Opaque pagination cursor — use the value from nextCursor in the previous response.

limit
integer
default:20

Page size (default 20, max 100)

Required range: 1 <= x <= 100

Response

Merchants list

merchants
object[]
required
totalCount
integer
required

Total number of merchants matching the query (ignoring pagination)

Required range: -9007199254740991 <= x <= 9007199254740991
nextCursor
string | null
required

Cursor for the next page, or null if no more results