Merchant

List Merchants

Returns every active merchant owned by the calling account. A merchant is considered active when its deleted_at is NULL or set to a future date. Soft-deleted merchants (deleted_at <= now) are excluded from results.

Authentication

X-API-KEYstring
API Key authentication via header

Response

OK
contactEmailstring
Primary contact email
contactFirststring
Primary contact first name
contactLaststring
Primary contact last name
merchantIdstring
UUID of the merchant
merchantNamestring
Merchant business name
statusenum
Derived lifecycle status
referenceIdstring
The ID you use in your own system to identify this merchant.

Errors

401
List Merchants Request Unauthorized Error
500
List Merchants Request Internal Server Error