> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.getkard.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getkard.com/_mcp/server. # Get Eligible Merchants GET https://rewards-api.getkard.com/rewards/merchant/user/{referringPartnerUserId} Retrieve national merchants data that a specified user has eligible national offers at. Call this endpoint to build out 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. Required scopes: `rewards:read` Reference: https://docs.getkard.com/legacy/api/rewards/merchants/get-merchants-by-user ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://rewards-api.getkard.com` (Production, default) - `https://test-rewards-api.getkard.com` (Sandbox) ## Request ### Path parameters - `referringPartnerUserId` (string, required) — Referring partner user ID from issuer that specifies user ### Query parameters - `page` (integer, optional) — Page number [>= 0], (default = 0) - `limit` (integer, optional) — Maximum number of merchants to be returned [1 - 200], (default = 200) - `category` (enum, optional) — Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage) - Allowed values: `Arts & Entertainment`, `Baby, Kids & Toys`, `Books & Digital Media`, `Clothing, Shoes & Accessories`, `Computers, Electronics & Software`, `Convenience`, `Gas`, `Department Stores`, `Food & Beverage`, `Health & Beauty`, `Home & Garden`, `Miscellaneous`, `Occasions & Gifts`, `Pets`, `Sports & Outdoors`, `Supplies & Services`, `Travel` ## Response ### 200 - `list of MerchantWithAttribution` ## Errors ### 400 Invalid Request - `InvalidRequestUnion` ### 404 Does Not Exist Error - `string` ### 500 Internal Server Error - `string` ### 401 Unauthorized Error - `message` (string, required) ## Types ### MerchantWithAttribution - `_id` (string, required) — Merchant ID in Kard's system - `acceptedCards` (list of enum, required) - Allowed values: `VISA`, `MASTERCARD`, `AMERICAN EXPRESS`, `DISCOVER` - `category` (enum, required) — Category of merchant - Allowed values: `Arts & Entertainment`, `Baby, Kids & Toys`, `Books & Digital Media`, `Clothing, Shoes & Accessories`, `Computers, Electronics & Software`, `Convenience`, `Gas`, `Department Stores`, `Food & Beverage`, `Health & Beauty`, `Home & Garden`, `Miscellaneous`, `Occasions & Gifts`, `Pets`, `Sports & Outdoors`, `Supplies & Services`, `Travel` - `createdDate` (datetime, required) — Created date of merchant in Kard's system (UTC) - `description` (string, required) — Merchant description - usually a blurb outlining more details about the merchant - `lastModified` (datetime, required) — Last modified date of merchant in Kard's system (UTC) - `name` (string, required) — Merchant name - `offers` (list of MerchantOfferWithAttribution, required) — Offers associated to the merchant - `source` (enum, required) — Merchant source - Allowed values: `NATIONAL`, `LOCAL` - `websiteURL` (string, required) — Merchant's URL website - `imgUrl` (string, required, deprecated) — \[Deprecated — Please use imgUrl on the offer object which contain attribution tokens]. Merchant image asset URL - `bannerImgUrl` (string, optional, deprecated) — \[Deprecated — Please use bannerImgUrl on the offer object which contain attribution tokens]. Merchant banner image asset URL ### RequestValidationErrorResponse - `errors` (list of string, required) ### MerchantOfferWithAttribution - `_id` (string, required) — Offer ID in Kard's system - `commissionType` (enum, required) — Type of commission on offer (% or a flat $) - Allowed values: `FLAT`, `PERCENT` - `createdDate` (datetime, required) — Create date of offer (UTC) - `expirationDate` (datetime, required) — Expiration date of offer if applicable (UTC) - `isLocationSpecific` (boolean, required) — Is offer location specific - `isTargeted` (boolean, required) — True returns targeted offers, false returns targeted and non-targeted offers - `lastModified` (datetime, required) — Last modified date of offer (UTC) - `merchantId` (string, required) — Id of Merchant associated with Offer - `name` (string, required) — Name of offer - `offerType` (enum, required) — Type of offer (whether it is run online or in-store) - Allowed values: `INSTORE`, `ONLINE` - `optInRequired` (boolean, required) — Is opt in required - `redeemableOnce` (boolean, required) — Is the offer redeemable once - `startDate` (datetime, required) — Beginning date of offer (UTC) - `terms` (string, required) — Terms and conditions on offer - `totalCommission` (double, required) — Commission going to issuer and cardholder - `bannerImgUrl` (string, optional) — Banner image URL asset containing attribution tokens - `imgUrl` (string, optional) — Image URL asset containing attribution tokens - `issuersCommission` (double, optional) — Commission going to the issuer - `maxRewardAmount` (integer, optional) — Max Reward Amount for Offer, if available - `maxTransactionAmount` (integer, optional) — Max Transaction Amount for Offer, if available - `merchantLocationIds` (list of string, optional) — Location Ids when isLocationSpecific is true - `minRewardAmount` (integer, optional) — Min Reward Amount for Offer, if available - `minTransactionAmount` (integer, optional) — Min Transaction Amount for Offer, if available - `usersCommission` (double, optional) — Commission going to user ## Examples **Response** ```json [ { "_id": "5e27318c9b346f00087fbb5c", "acceptedCards": [ "AMERICAN EXPRESS", "MASTERCARD", "VISA", "DISCOVER" ], "category": "Food & Beverage", "createdDate": "2022-03-12T05:00:58.456Z", "description": "N/A", "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", "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, "bannerImgUrl": "https://www.someoffer.com/banner", "imgUrl": "https://www.someoffer.com/image.png", "issuersCommission": 3.5, "maxRewardAmount": 20, "maxTransactionAmount": 20, "merchantLocationIds": [ "12abc45ef" ], "minRewardAmount": 5, "minTransactionAmount": 5, "usersCommission": 6 } ], "source": "NATIONAL", "websiteURL": "https://www.somemerchant.com", "imgUrl": "https://www.somemerchant.com/image.png", "bannerImgUrl": "https://www.somemerchant.com/bannerImage.png", "type": "CARDLINKED" } ] ``` **SDK Code** ```python import requests url = "https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D" querystring = {"limit":"1","page":"0"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/rewards/merchant/user/%7BreferringPartnerUserId%7D?limit=1&page=0")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```