Skip to main content
GET
/
merchants
Get detailed merchant information (beta)
curl --request GET \
  --url https://east.sandbox.spade.com/merchants \
  --header 'X-Api-Key: <api-key>'
{
  "counterparties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "similarity": 123,
      "logo": "<string>",
      "website": "<string>",
      "affiliates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "logo": "<string>",
          "website": "<string>"
        }
      ],
      "alternates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "similarity": 123
        }
      ],
      "expectedMerchantCategoryCodes": [
        {
          "code": "<string>",
          "description": "<string>"
        }
      ],
      "expectedSpadeCategories": [
        {
          "id": "<string>",
          "name": "<string>",
          "icon": "<string>",
          "fullCategoryHierarchy": [
            {
              "id": "<string>",
              "name": "<string>",
              "icon": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "thirdParties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "<unknown>",
      "similarity": 123,
      "logo": "<string>",
      "website": "<string>"
    }
  ]
}

Authorizations

X-Api-Key
string
header
required

Query Parameters

name
string
required

The name of the merchant you want to find

Response

Successful operation

counterparties
object[]

An array of counterparties matching the search query, ordered from most to least similar. Can contain up to five counterparties.

thirdParties
object[]

An array of third parties matching the search query, ordered from most to least similar. Can contain up to five third parties.