Get Merchants | Kard API

[
  {
    "_id": "5e27318c9b346f00087fbb5c",
    "acceptedCards": [
      "AMERICAN EXPRESS",
      "MASTERCARD",
      "VISA",
      "DISCOVER"
    ],
    "category": "Food & Beverage",
    "createdDate": "2022-03-12T05:00:58.456Z",
    "description": "N/A",
    "imgUrl": "https://www.somemerchant.com/image.png",
    "lastModified": "2022-03-12T05:00:58.456Z",
    "name": "Some merchant",
    "offers": [
      {
        "_id": "5e27318c9b346f00087fbb5b",
        "commissionType": "PERCENT",
        "createdDate": "2022-03-12T05:00:58.456Z",
        "expirationDate": "2022-03-12T05:00:58.456Z",
        "isLocationSpecific": false,
        "isTargeted": true,
        "lastModified": "2022-03-12T05:00:58.456Z",
        "merchantId": "5e27318c9b346f00087fbb5c",
        "name": "Some offer",
        "offerType": "INSTORE",
        "optInRequired": false,
        "redeemableOnce": true,
        "startDate": "2022-01-01T05:00:00Z",
        "status": "ACTIVE",
        "terms": "Not all cards are eligible and not all transactions can be monitored. For debit cards, run transaction as credit, do not use PIN. Offer valid from 12/19/2018. Maximum individual reward 250 dollars. The business may change or end the Offer at any time up to the point of purchase without notice.",
        "totalCommission": 9.5,
        "issuersCommission": 3.5,
        "maxRewardAmount": 20,
        "maxTransactionAmount": 20,
        "merchantLocationIds": [
          "12abc45ef"
        ],
        "minRewardAmount": 5,
        "minTransactionAmount": 5,
        "usersCommission": 6
      }
    ],
    "source": "NATIONAL",
    "websiteURL": "https://www.somemerchant.com",
    "bannerImgUrl": "https://www.somemerchant.com/bannerImage.png",
    "type": "CARDLINKED"
  }
]

Retrieve ALL national and local merchant data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use Get Eligible Merchants to retrieve national merchant data and build your targeted offers UX experience. Local merchants and offers details can be found by calling the Get Eligible Locations endpoint with the includeLocal query parameter.
Required scopes: rewards:read

Retrieve ALL national and local merchant data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use [Get Eligible Merchants](/legacy/api/rewards/merchants/get-merchants-by-user) to retrieve national merchant data and build your [targeted offers UX experience](https://github.com/kard-financial/kard-postman?tab=readme-ov-file#b-targeted-offers). Local merchants and offers details can be found by calling the [Get Eligible Locations](/legacy/api/rewards/locations/get-locations-by-user) endpoint with the `includeLocal` query parameter.<br/> <b>Required scopes:</b> `rewards:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number [>= 0], (default = 0)

limitintegerOptional

Maximum number of merchants [1 - 200], (default = 200)

sourceenumOptional

Merchant source

Allowed values:

categoryenumOptional

Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

Response

This endpoint returns a list of objects.

_idstring

Merchant ID in Kard's system

acceptedCardslist of enums

Allowed values:

categoryenum

Category of merchant

createdDatedatetime

Created date of merchant in Kard’s system (UTC)

descriptionstring

Merchant description - usually a blurb outlining more details about the merchant

imgUrlstring

Merchant image asset URL

lastModifieddatetime

Last modified date of merchant in Kard’s system (UTC)

namestring

Merchant name

offerslist of objects

Offers associated to the merchant

sourceenum

Merchant source

Allowed values:

websiteURLstring

Merchant's URL website

bannerImgUrlstringOptional

Merchant banner image asset URL

Errors

400

Invalid Request

401

Unauthorized Error

500

Internal Server Error