Sign in

v1

latestOpenAPI 3.1.02026-07-262343124.1 KB
Merchant Management

List merchants

List the partner's merchants. Supports filtering by status, free-text search over name and ID, and cursor-based pagination via cursor and limit.

get/v1/merchants

Query parameters

status'active' | 'inactive' | 'suspended'

Filter by merchant status

searchstring
Example:Acme

Search by merchant name or ID (case-insensitive)

cursorstring

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

limitinteger

Page size (default 20, max 100)

Response

Merchants list

totalCountinteger required

Total number of merchants matching the query (ignoring pagination)

nextCursorstring nullable required

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

Example response

{
  "merchants": [
    {
      "id": "mrch_7kBz2qR9xPvLmN4Yw",
      "email": "billing@acme.store",
      "status": "active",
      "iconUrl": "https://imagedelivery.net/example/acme-icon.png",
      "createdAt": "2025-06-15T10:30:00.000Z"
    }
  ]
}