Merchants

Search merchants

Changed on

Search Merchants by name

get/api/merchants/search

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/merchants/search
  • Auth
    API key in header x-api-key

Query parameters

namestring required

Full or partial name, minimum 3 characters

only_priorityboolean

If true, only returns priority merchants

Response

A list of up to 5 merchants which match the search term, sorted by descending order of their URL rank and the frequency this merchant has been seen historically.

Example response

{
  "merchants": [
    {
      "categories": [
        {
          "code": "7311",
          "description": "Advertising services",
          "slug": "advertising_services"
        }
      ],
      "heron_id": "mrc_Qc7dvS9RnASVzUMxxfVgsZ"
    }
  ]
}

Changes

    • warning

      added the new debt.collections.mca enum value to the // response property for the response status