Skip to main content
GET /merchants returns a paginated list of every merchant sub-account linked to your company. Use the search parameter to quickly look up a specific merchant by name, email, phone number, brand name, businessAccountCode, or externalMerchantId — handy for resolving a merchant before placing an order or checking onboarding status in bulk.

Requirements

  • Account type: Company account only.
  • Scope: merchants

Authentication

Query parameters

integer
Page number to return. Defaults to 1.
integer
Number of merchants per page. Defaults to 50.
Full-text search across name, email, phoneNumber, brandName, businessAccountCode, and externalMerchantId. Partial matches are supported.

Request

Response

200 — Success

array
Array of merchant objects for the current page.
object
Pagination metadata for the current result set.

Errors

Use search with your externalMerchantId to check whether a merchant was already onboarded before calling POST /merchants. This lets you implement idempotent onboarding without catching 409 errors.