v1

latestSwagger 2.02026-07-1483829.8 KB

Offer Details

Returns Information on an Offer

This resource returns extended information for the requested offer, typically used to display a detail view.

get/offerdetails

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.

OfferIdstring required

System-wide identifier for the campaign, not intended for end-user display.

Response

This resource returns extended information for the requested offer, typically used to display a detail view.

Example response

{
  "Response": {
    "OfferDetails": {
      "CurrencyCode": "USD",
      "DetailPostpaidCreditOffer": {
        "CurrencyCode": "USD",
        "StatementCreditType": "SPEND_CASH"
      },
      "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",
      "LongDescription": "On your next purchase of $30 or more at Example.com online or at a store, receive $10.00 back posted to the card associated with this account.",
      "Merchant": {
        "Category": "DEPARTMENTSTORE",
        "Name": "Example.com",
        "StoreLocatorUrl": "http://www.example.com/locations/",
        "WebsiteUrl": "http://www.example.com/"
      },
      "OfferDisplay": {
        "DetailedTerms": "Offer is non-transferable and applies to one purchase of a min. of $30 online or in store charged to your card by the expiration date."
      },
      "OfferId": "c7dcfca7-cf35-36b0-9e67-d4f363d643e0",
      "OfferMedia": {
        "OfferImages": [
          {
            "AltText": "Example.com",
            "Description": "The logo for Example.com",
            "ImageUrl": "https://truaxis.mastercard.com/assets/sr/source/billshrink/example_medium.png"
          }
        ]
      },
      "OfferSource": "Truaxis",
      "OfferType": "POSTPAIDCREDIT",
      "RedemptionMode": "CASH",
      "RedemptionType": "ONLINE-INSTORE",
      "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."
    },
    "Status": {
      "Message": "Success"
    }
  }
}