v1

latestSwagger 2.02026-07-1483829.8 KB

Matched Offers

Returns Matched Offers

This resource returns offers that are available to the user and conform to the search criteria (if specified).

get/matchedoffers

Query parameters

FIdstring required

Financial Institution Identifier. Code that specifies the platform and configuration instance, provided by Mastercard during implementation.

UserTokenstring required

Session identifier as returned by the UserToken resource.

Langstring

When utilized with a multi-lingual implementation, may be the tongue and country of the user in ISO 639-1, underscore, ISO 3166-1 alpha-2 format.

MerchantNamestring

Fuzzy term to search retailers with offers for the user. In general, searching of Matched Offers is not advised as users generally have a modest selection of highly relevant promotions.

Categorystring

Offer Categories.

OfferTypestring

The kind of deal. POSTPAIDCREDIT- Statement Credit Offer, which is a discount that is automatically applied to the card linked to the user and utilized to make the purchase.

PageNumberinteger

Segment of offers to return.

ItemsPerPageinteger

Segment size of offer to be returned. Default is 25.

Response

This resource returns offers that are available to the user and conform to the search criteria (if specified).

Example response

{
  "Response": {
    "CurrentPage": 1,
    "Items": {
      "MatchedOffer": {
        "ActiveSc": "AVAILABLE",
        "CurrencyCode": "USD",
        "EventEndDate": "2012-07-10",
        "EventStartDate": "2012-05-10",
        "Headline": "Shop at Example.com and get 20% back on purchase of $25 or more",
        "Language": "English",
        "Merchant": {
          "Category": "DEPARTMENTSTORE",
          "Name": "Example.com",
          "StoreLocatorUrl": "http://www.example.com/locations/",
          "WebsiteUrl": "http://www.example.com/"
        },
        "MerchantImageURL": "https://truaxis.mastercard.com/assets/sr/source/billshrink/example.png",
        "OfferId": "c7dcfca7-cf35-36b0-9e67-d4f363d643e0",
        "OfferSource": "Truaxis",
        "OfferType": "POSTPAIDCREDIT",
        "RedemptionMode": "CASH",
        "ShortDescription": "On your next purchase of $25 or more at Example.com online or at a store, receive 20% back posted to the card associated with this account."
      }
    },
    "ItemsPerPage": 1,
    "NumberOfPages": 1,
    "Status": {
      "Message": "Success"
    },
    "TotalCount": 8
  }
}