Enrich multiple transactions - POST

Find merchants based on raw transaction data

post

Searches for an array of merchants. This endpoint is typically used for transaction list views. You send in multiple transactions at once in a single request.

Authorizations

Body

typestring · enumRequiredPossible values:

logo_sizestring · enumOptionalDefault: 2xPossible values:

defaultLogobooleanOptionalDefault: true

languagestringOptional

additionalInfobooleanOptionalDefault: false

clearResponsebooleanOptionalDefault: true

forceCacheableFieldsstring[]Optional

An optional array of response fields that will be force returned from our internal sources. This is useful if you want to cache fields such as the name or website during an extended call. Allowed values are: name, website, img, category, categories

Example: ["name","website"]

Responses

200

A JSON object containing one property per transaction enriched. The keys of this object are the ID that was provided, previously passed in as the `"id"` property in each transaction array element. The value of this property is the array of merchants that were found when searching for that specific transaction

application/json

400

Returned when the request is malformed. Double check that you are sending the correct parameters in the request, and that they are valid. This error is also thrown when a trial account has expired or exceeded its usage limits.

application/json

401

Returned when the API key is invalid. Double check that you are sending the correct API key in the `X-Api-Key` header.

application/json

403

Returned when the API key is missing. Double check that you are sending the API key in the `X-Api-Key` header.

text/html

404

Returned when the endpoint is not found. Double check that you are sending the request to the correct endpoint.

application/jsontext/html

500

Returned when the request has failed due to an internal server error. Please retry the request later.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v3/merchant/list HTTP/1.1
Host: europe-west2.snowdrop-mrs.com
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "type": "extended",
  "logo_size": "2x",
  "defaultLogo": true,
  "language": "text",
  "additionalInfo": true,
  "clearResponse": true,
  "forceCacheableFields": [
    "name",
    "website"
  ],
  "transactions": [
    {
      "id": "text",
      "merchant_name": "text",
      "location": "text",
      "address": "text",
      "city": "text",
      "country": "text",
      "postcode": "text",
      "mcc": "text",
      "online": true,
      "latitude": 1,
      "longitude": 1,
      "radius": 1
    }
  ]
}

{
  "id": [
    {
      "name": "text",
      "website": "text",
      "position": {
        "type": "Point",
        "coordinates": [
          1
        ]
      },
      "img": "text",
      "logoImg": "text",
      "categoryImg": "text",
      "logoScore": 1,
      "address": "text",
      "postal_code": "text",
      "street_number": "text",
      "route": "text",
      "locality": "text",
      "administrative_area_level_1": "text",
      "administrative_area_level_2": "text",
      "country": "text",
      "phone": "text",
      "rating": 4.1,
      "reviews": {
        "author_name": "A Google User",
        "author_url": "text",
        "profile_photo_url": "text",
        "language": "text",
        "original_language": "text",
        "rating": 1,
        "relative_time_description": "text",
        "text": "text",
        "time": 1,
        "translated": true
      },
      "opening_hours": {
        "open_now": true,
        "periods": [
          {
            "open": {
              "date": "text",
              "day": 1,
              "time": 1700,
              "truncated": true
            },
            "close": {
              "date": "text",
              "day": 1,
              "time": 1700,
              "truncated": true
            }
          }
        ],
        "special_days": [
          {
            "date": "text",
            "exceptional_hours": true
          }
        ],
        "type": "text",
        "weekday_text": [
          "Monday: 9:00 AM – 5:00 PM",
          "Tuesday: 9:00 AM – 5:00 PM",
          "Wednesday: 9:00 AM – 5:00 PM",
          "Thursday: 9:00 AM – 5:00 PM",
          "Friday: 9:00 AM – 5:00 PM",
          "Saturday: Closed",
          "Sunday: Closed"
        ]
      },
      "price_level": 1,
      "place_id": "ChIJN1t_tDeuEmsRUsoyG83frY4",
      "category": "text",
      "categories": [
        "text"
      ],
      "intermediary": {
        "name": "Paypal",
        "website": "https://www.paypal.com",
        "img": "https://storage.googleapis.com/production-mrs-tm-logos/6273e53abb09494554c93872_2x.png"
      },
      "isClearResponse": false,
      "cachePolicy": {
        "name": "Google",
        "website": "Google",
        "position": "Google",
        "img": "Google",
        "logoImg": "Google",
        "categoryImg": "Google",
        "logoScore": "Google",
        "address": "Google",
        "postal_code": "Google",
        "street_number": "Google",
        "route": "Google",
        "administrative_area_level_1": "Google",
        "administrative_area_level_2": "Google",
        "country": "Google",
        "phone": "Google",
        "opening_hours": "Google",
        "place_id": "Google",
        "category": "Google",
        "categories": "Google",
        "isClearResponse": "MRS"
      },
      "brand": {
        "id": "64b70cd0584b4b1e7ebcf35d",
        "name": "Carrefour Express",
        "img": "https://storage.googleapis.com/production-mrs-brand-logos/6273e357bb09494554c92a5a_2x.png",
        "website": "http://www.carrefour.com/",
        "esg": {
          "participations": []
        },
        "brandCategory": {
          "parentCategory": "Retail & Shopping",
          "categoryGroup": "Retail & Department Stores",
          "categoryType": "Furniture"
        },
        "verifiedInputDate": "2024-09-02T08:46:35.785Z"
      },
      "aggregateLevel": {
        "id": "64b70cd0584b4b1e7ebcf36d",
        "name": "Carrefour",
        "img": "https://storage.googleapis.com/production-mrs-tm-logos/6273e58dbb09494554c93ae3_2x.png",
        "website": "https://www.carrefour.com/"
      },
      "store": {
        "id": "66c78aa32cea1a4463b8c634"
      }
    }
  ]
}