v1

latestSwagger 2.02026-07-1483829.8 KB

Redeemed Offers

Returns Redeemed Offers

This resource returns offers that have been fulfilled by the user.

get/redeemedoffers

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.

PageNumberinteger

Segment of offers to return.

ItemsPerPageinteger

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

Response

This resource returns offers that have been fulfilled by the user.

Example response

{
  "Response": {
    "CurrentPage": 1,
    "Items": {
      "RedemedOffer": {
        "ActivationDate": "2015-10-15",
        "ActivationId": "TRU_1000136",
        "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.",
        "MaxUserRedemptions": 1,
        "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 $30 or more at Example.com inline or at a store, receive $10.00 back posted to the card associated with this account.",
        "Transactions": {
          "RedemptionDate": "2015-10-12"
        }
      }
    },
    "ItemsPerPage": 1,
    "NumberOfPages": 1,
    "Status": {
      "Message": "Success"
    },
    "TotalCount": 8
  }
}