Sign in
Capabilities

merchants.list

List and search merchants with document counts, spend totals, currencies, and profile fields.

post/capabilities/merchants.list

Request body

searchstring

Search term to filter merchants by name

fromDatestring

Only include documents on or after this date

toDatestring

Only include documents on or before this date

currencystring

Only include documents in this source currency

sortBy'name' | 'totalSpent' | 'count' | 'lastTransaction'
pageinteger

Page number

limitinteger

Results per page

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.