Skip to main content
POST
/
merchants
/
match
Match a merchant
curl --request POST \
  --url https://east.sandbox.spade.com/merchants/match \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "merchantName": "<string>",
  "address": "<string>",
  "city": "<string>",
  "region": "<string>",
  "country": "<string>",
  "postalCode": "<string>",
  "requestId": "<string>",
  "latitude": 123,
  "longitude": 123,
  "website": "<string>",
  "customAttributes": {}
}
'
{
  "requestId": "<string>",
  "counterparty": {
    "id": "<string>",
    "name": "<string>",
    "similarity": 123
  },
  "location": {
    "id": "<string>",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "similarity": 123
  },
  "customAttributes": {}
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
merchantName
string
required

Name of the merchant.

address
string
required

Street address of the merchant.

city
string
required

City where the merchant is located.

region
string
required

Region or state where the merchant is located.

country
string
required

Country where the merchant is located.

postalCode
string
required

Postal code of the merchant's location.

requestId
string

Your ID for this request. Optional.

latitude
number

Latitude of the merchant's location.

longitude
number

Longitude of the merchant's location.

website
string<url>

Website of the merchant.

customAttributes
object

A dictionary containing custom attributes that you would like to be returned in the response. Please ensure this object does not contain any PII. Restrictions include: customAttributes must be an object, up 30 custom attributes are allowed, each key must be a string <= 40 characters in length, and each value must be a string <= 250 characters in length.

Response

Successful operation

requestId
string

Your ID for this request. null if not provided in the request.

counterparty
object
location
object
customAttributes
object

A dictionary containing the custom attributes that were included in the enrichment request (if any).