Offers

This page contains the internal Offers APIs. Before using, the user must first Self Register and then authenticate using Get Token.

To help you get started with your integration, Cloud Payments provides a sample Postman collection that includes a template of all the Offer API endpoints. It also includes a sample environment file with the URL details.

Click the button below to download the collection and associated the environment file.

Activate

Check Wallet Update

If your client is mobile application running in the mobile platform, supply end user’s OS name, your tenant name and current wallet service version and check if wallet update is available.

Key	Value
Method	POST
Resource URL	{Activate_URL}/v4/checkWalletUpdate
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Check Wallet Update Request

{"osName":"ANDROID","version":"1.0","walletId":"JANUS"}

Request Parameters

Name	Required	Description	Value/Range
osName	yes	OS name of end user’s mobile device. Possible values are ANDROID and IOS.	String
walletId	yes	Your tenant name. e.g. JANUS	String
version	yes	Version of wallet service currently installed on end user’s device.	String

Check Wallet Update Response When there is no new version available

{
  "result": {
    "code": 0
  },
  "existUpdateVersion": "N"
}

Check Wallet Update Response When there is a new version available

{
  "result": {
    "code": 0
  },
  "existUpdateVersion": "Y",
  "mandatoryYn": "N",
  "updateVersion": "2.0",
  "downloadUrl": "https://play.google.com/store/apps/details?id=com.skcc.wallet"
}

Response Parameters

Parameter Name	Type	Description
code	response code	integer
message		string
existUpdateVersion	Indicates if new version to be updated available. Possible value is Y and N.	String
mandatoryYn	Indicate if the new version is mandatory update. Current version must be updated to the mandatory update version. If existUpdateVersion has value ‘Y’, this parameter is available.	String
updateVersion	New version number to be updated. Custom value depending on tenant. If existUpdateVersion has value ‘Y’, this parameter is available. e.g. 2.0	String
downloadUrl	URL to download the new version to be updated. If existUpdateVersion has value ‘Y’, this parameter is available.e.g. https://play.google.com/store/apps/details?id=com.skcc.wallet	String

Get User Preferences

Retrieve list of user preferences to get user input. The result can be stored using updateWalletUser().

Key	Value
Method	POST
Resource URL	{Activate_URL}/v4/getUserPrefList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get User Preferences Request

{"walletId":"JANUS"}

Request Parameters

Parameter Name	Required	Description	Value/Range
walletId	Yes	Your tenant name	String.

Get User Preferences Response

{
  "result": {
    "code": 0
  },
  "userPrefList": [
    {
      "tgtAttrId": "7966E1C7-D905-464A-8484-6CE5ECBC40DE",
      "tgtAttrName": "Favorite visiting time",
      "tgtAttrValueList": [
        {
          "tgtAttrValue": "Afternoon"
        },
        {
          "tgtAttrValue": "Evening"
        },
        {
          "tgtAttrValue": "Morning"
        }
      ]
    },
    {
      "tgtAttrId": "2354FE7A-7F27-45BA-A46D-52E6CC06B00B",
      "tgtAttrName": "Foods",
      "tgtAttrValueList": [
        {
          "tgtAttrValue": "American"
        },
        {
          "tgtAttrValue": "Chinese"
        },
        {
          "tgtAttrValue": "French"
        },
        {
          "tgtAttrValue": "Italian"
        },
        {
          "tgtAttrValue": "Korean"
        },
        {
          "tgtAttrValue": "Mexican"
        }
      ]
    },
    {
      "tgtAttrId": "2D1C6311-34A5-4855-8DC3-FC156B81A4B0",
      "tgtAttrName": "Shopping habits",
      "tgtAttrValueList": [
        {
          "tgtAttrValue": "Monthly"
        },
        {
          "tgtAttrValue": "Shopaholic"
        },
        {
          "tgtAttrValue": "Weekly"
        }
      ]
    },
    {
      "tgtAttrId": "A33C881AC5D14287BD7C5C58E45AF669",
      "tgtAttrName": "Sports",
      "tgtAttrValueList": [
        {
          "tgtAttrValue": "Baseball"
        },
        {
          "tgtAttrValue": "Golf"
        },
        {
          "tgtAttrValue": "Tennis"
        }
      ]
    },
    {
      "tgtAttrId": "B1989FE05F11431AAA6339EFAD79AA2A",
      "tgtAttrName": "Weather2",
      "tgtAttrValueList": [
        {
          "tgtAttrValue": "Cloudy2"
        },
        {
          "tgtAttrValue": "Rainy2"
        },
        {
          "tgtAttrValue": "Sunny2"
        }
      ]
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
code	Response code	integer
message		string
tgtAttrId	Unique identifier of user targeting attribute	String
tgtAttrName	Name of user targeting attribute. e.g. Sports.	String
tgtAttrValueList	List of items in this user targeting attribute	List
tgtAttrValue	End user targeting attribute item. e.g. Baseball, Golf, Tennis, etc.	String

Offers

Get my Coupon Count

Retrieves the number of saved coupons for an end user.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getMyCouponCount/
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get My Coupon Count Request

{}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.

Get My Coupon Count Response

{
  "result": {
    "code": 0
  },
  "count": 3
}

Response Parameters

Parameter Name	Type	Description
count	integer	Saved Coupon count of the end user.
code	integer	Response code
message	string

Get Coupon Categories

Retrieves your pre-defined custom coupon categories. Supply your unique offer service ID that was returned from your previous request, and the coupon categories will be returned.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getCouponCategories
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Coupon Categories Request

{
           "serviceId": "10002"
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	Yes	String	Unique identifier for the offer service.

Get Coupon Categories Response

{
  "result": {
    "code": 0
  },
  "categoryList": [
    {
      "categoryId": "100",
      "categoryName": "Food and Cooking",
      "desc": "default description"
    },
    {
      "categoryId": "200",
      "categoryName": "Restaurants",
      "desc": "default description"
    },
    {
      "categoryId": "300",
      "categoryName": "Travel",
      "desc": "default description"
    },
    {
      "categoryId": "400",
      "categoryName": "Automotive and Fuel",
      "desc": "default description"
    },
    {
      "categoryId": "500",
      "categoryName": "Family and Living/Home",
      "desc": "default description"
    },
    {
      "categoryId": "600",
      "categoryName": "Culture and Entertainment",
      "desc": "default description"
    },
    {
      "categoryId": "700",
      "categoryName": "Health and Beauty ",
      "desc": "default description"
    },
    {
      "categoryId": "800",
      "categoryName": "Electronics and Office",
      "desc": "default description"
    },
    {
      "categoryId": "900",
      "categoryName": "Health Care",
      "desc": "default description"
    },
    {
      "categoryId": "1000",
      "categoryName": "Fashion",
      "desc": "default description"
    },
    {
      "categoryId": "1100",
      "categoryName": "Sports and Fitness",
      "desc": "default description"
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
code	integer	Response code
message	string
categoryId	string	ID of the category that the coupon is belonged.
categoryName	string	Name of category
desc	string	Description of the category

Get Merchant List

Update coupon instance state inactive. Supply list of end user’s coupon instance ID that were returned from your previous request, and the updated result is returned.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getMerchantList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Merchant List Request.

{
           "latitude": 13.3833,
           "longitude": 52.5167,
           "maxResults": 50,
           "radius": 51000,
           "skipRows": 0,
           "sortBy": 0
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service. e.g. 10517
latitude	Yes	Double	Latitude to find data in the range. e.g. 34.044454912173904
longitude	Yes	Double	Longitude to find data in the range. e.g. -84.48063315578163
maxResult	Yes	Integer	Maximum number of data to be returned. Along with skipRows, you can use this for pagination. e.g. 5 returns up to 5 coupons. example: 20
radius	Yes	Integer	Radius from latitude and longitude to find coupons in the range. Unit is km. e.g.: 1000000
skipRows	No	Integer	Starting row of data in the list being requested. For example, 2 is set, the first two rows will be skipped. Along with maximum number of rows, you can use this for pagination.
sortBy	No	Integer	Define how to sort the returned data. Default is 0. Possible values are 0 to sort data by distance, with the nearest merchant appearing first. 1 to sort data by name, with the A to Z order. 2 to sort data by the number of available in the merchant coupon, with the most merchant appearing first.

Get Merchant list Response

{
  "result": {
    "code": 0
  },
  "merchantList": [
    {
      "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "merchantName": "Burger King",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "merchantDtim": "2018-10-25T14:34:23.000+0000",
      "nearestStore": {
        "locationId": "8F18CFAF-DF38-4A7E-B541-7031E370ED3D",
        "locationName": "Burger King Alpharetta",
        "latitude": 34.04935,
        "longitude": -84.15855,
        "distance": 13030.639719519537,
        "addr1": "5025 Abbotts Bridge Rd",
        "city": "Alpharetta",
        "state": "GA",
        "country": "US",
        "zipCode": "30005",
        "openHours": [
          {
            "day": "MON",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "TUE",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "WED",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "THU",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "FRI",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "SAT",
            "open": "0600",
            "close": "2300"
          },
          {
            "day": "SUN",
            "open": "0600",
            "close": "2300"
          }
        ],
        "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
        "amenity": {
          "wifi": true,
          "driveThru": true,
          "mobilePay": true,
          "accessibility": true,
          "fullService": true,
          "specialVenue": false
        }
      },
      "couponCount": 8
    },
    {
      "merchantId": "62B57113-34D3-4472-B811-CED3A490ABD8",
      "merchantName": "Marriott",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/62B57113-34D3-4472-B811-CED3A490ABD8_xhdpi.png",
      "merchantDtim": "2018-10-25T14:34:35.000+0000",
      "nearestStore": {
        "locationId": "F284B88E-0973-419B-8E2C-735A40B027C1",
        "locationName": "Courtyard by Marriott Atlanta Buford",
        "latitude": 34.049352,
        "longitude": -84.158626,
        "distance": 13030.644826808648,
        "addr1": "1405 Mall of Georgia Blvd",
        "city": "Buford",
        "state": "GA",
        "country": "US",
        "zipCode": "30519",
        "merchantId": "62B57113-34D3-4472-B811-CED3A490ABD8",
        "amenity": {
          "wifi": true,
          "driveThru": false,
          "mobilePay": true,
          "accessibility": true,
          "fullService": true,
          "specialVenue": false
        }
      },
      "couponCount": 1
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
merchantList	string	Identifier of merchant where the coupon can be redeemed.
merchantDtim	string	Date and time that merchant registered
merchantId	string	Unique identifier of merchant
merchantImageUrl	string	URL to retrieve merchant logo
merchantName	string	Name of merchant
code	integer	Response code
message	string

Get Coupons

A Get Coupons request takes search conditions input and returns all active coupons for end user view.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Coupons Request

{
"latitude":34.044454912173904,
"longitude":-84.48063315578163,
"maxResults":20,
"radius":1000000,
"skipRows":0,
"merchantList": [
    "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A"
  ],
"categoryIds": [
    "200"
  ]
}

Request Parameters

Name	Required	Description	Value/Range
latitude	no	Latitude to find coupons in the range e.g.34.044454912173904	double
longitude	no	Longitude to find coupons in the range e.g.-84.48063315578163	double
maxResults	no	Maximum number of data to be returned. Along with skipRows, you can use this for pagination. e.g. 5 returns up to 5 coupons	Integer
radius	no	Country where the company is located.	Returns 3 letter country code. Should comply with ISO 3166.
skipRows	no	Starting row of data in the list being requested. For example, 2 is set, the first two rows will be skipped. Along with maxRows, you can use this for pagination.	Integer
categoryIds	no	Product category ID of the coupon. This is tenant’s custom configuration. For tenant ‘JANUS’, the following values are configured. - 100: Food and Cooking - 200: Restaurants - 300: Travel - 400: Automotive and Fuel - 500: Family and Living/Home - 600: Culture and Entertainment - 700: Health and Beauty - 800: Electronics and Office - 900: Health Care - 1000: Fashion - 1100: Sports and Fitness	String
merchantList	no	Identifier of merchant where the coupon can be redeemed. e.g.1703276A-3709-45C5-B7EE-F5927D6D9EFA.	String

Get Coupons Response

{
  "result": {
    "code": 0
  },
  "couponList": [
    {
      "couponId": "753FB5CE3585443DB9EF68E21DA2A884",
      "couponName": "Free hashbrowns",
      "couponDesc": "Free hashbrowns with a sandwich purchase",
      "redeemType": "ONETIME",
      "publishDtim": "2018-12-10T08:00:00.000+0000",
      "expiryDtim": "2019-12-24T16:00:00.000+0000",
      "brandId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "brandName": "Burger King",
      "brandImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "brandImageDtim": "2018-12-13T14:41:53.000+0000",
      "couponImageUrl": "http://api-dev.fintiv.co:8080/image/coupon/753FB5CE3585443DB9EF68E21DA2A884_detail_xhdpi.png",
      "couponImageThumbUrl": "http://api-dev.fintiv.co:8080/image/coupon/753FB5CE3585443DB9EF68E21DA2A884_list_xhdpi.png",
      "couponImageDtim": "2018-12-13T14:41:53.000+0000",
      "national": false,
      "recommendable": true,
      "featured": false,
      "distance": 29.7,
      "categoryId": "200",
      "nfcEnabled": false,
      "onlineEnabled": false
    },
    {
      "couponId": "816BA38D236244D2853FBB44E9B16526",
      "couponName": "3 Danishes for $5",
      "couponDesc": "3 Danishes for $5",
      "expiryDtim": "2019-12-31T17:00:00.000+0000",
      "brandId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "brandName": "Burger King",
      "brandImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "brandImageDtim": "2019-01-08T16:40:19.000+0000",
      "couponImageUrl": "http://api-dev.fintiv.co:8080/image/coupon/816BA38D236244D2853FBB44E9B16526_detail_xhdpi.png",
      "couponImageThumbUrl": "http://api-dev.fintiv.co:8080/image/coupon/816BA38D236244D2853FBB44E9B16526_list_xhdpi.png",
      "couponImageDtim": "2019-01-08T16:40:19.000+0000",
      "recommendable": true,
      "featured": false,
      "distance": 29.7,
      "categoryId": "200",
      "nfcEnabled": false,
      "onlineEnabled": false
    },
    {
      "couponId": "5FE882C2AF724013B3C4202B80EA176C",
      "couponName": "BOGO Donut",
      "couponDesc": "BOGO Donut",
      "expiryDtim": "2019-12-31T19:00:00.000+0000",
      "brandId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "brandName": "Burger King",
      "brandImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "brandImageDtim": "2019-01-08T16:40:30.000+0000",
      "couponImageUrl": "http://api-dev.fintiv.co:8080/image/coupon/5FE882C2AF724013B3C4202B80EA176C_detail_xhdpi.png",
      "couponImageThumbUrl": "http://api-dev.fintiv.co:8080/image/coupon/5FE882C2AF724013B3C4202B80EA176C_list_xhdpi.png",
      "couponImageDtim": "2019-01-08T16:40:30.000+0000",
      "recommendable": true,
      "featured": false,
      "distance": 29.7,
      "categoryId": "200",
      "nfcEnabled": false,
      "onlineEnabled": false
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
couponId	String	Unique identifier of the coupon.
couponName	String	The simple name of the coupon.
couponDesc	String	A brief text outlining the offer used in the list view of the offers.
expiryDtim	String($date-time)	The date on which the coupon expires.Format is yyyy-MM-dd’T’HH:mm:ssZ
brandId	String	ID of the brand sponsoring the coupon
brandImageUrl	String	URL of image of the brand
brandImageDtim	String($date-time)	Timestamp that brand image is updated
couponImageUrl	String	URL of detail image of the coupon. Calling this URL returns the actual graphic of detail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageThumbUrl	String	URL of thumbnail image of the coupon. Calling this URL returns the actual graphic of thumbnail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageDtim	String($date-time)	Timestamp that coupon image is updated.Format is yyyy-MM-dd’T’HH:mm:ssZ
recommendable	Boolean	Whether the coupon is recommendable or not.
featured	Boolean
distance	Double	Distance between the requested position and the target location to redeem the offer
categoryId	String	ID of the category that the coupon is belonged.
nfcEnabled	Boolean	Has the value true if the offer supports NFC or the value false if the offer does not support NFC
onlineEnabled	Boolean	Has the value true if the offer is available online or the value false if the offer is not available online

Add my Coupons

A customer can save coupons they like by supplying one or multiple unique coupon IDs that were returned from a previous request.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/addMyCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Add my Coupons Request

{
            "couponIdList": ["816BA38D236244D2853FBB44E9B16526"],
            "locationIdList": ["8F18CFAF-DF38-4A7E-B541-7031E370ED3D"]
        }

Request Parameters

Parameter Name	Required	Type	Description
serviceId	no	String	Unique identifier for the offer service that the coupon belongs to. For offer, there may be two services; basic coupon service and marketplace service. * 10515 (Basic coupon service) * 10522 (Marketplace service)
couponIdList	yes	String	A list of unique coupon IDs for saving.
locationIdList	no	String	A list of unique identifiers for stores which accept a coupon.

Add my Coupons Response

{
  "result": {
    "code": 0
  },
  "couponInstances": [
    {
      "type": "CouponDetails",
      "couponId": "816BA38D236244D2853FBB44E9B16526",
      "couponInstanceId": "8B3A98BB-7EB9-4B31-ACB9-D7000DE2D799",
      "locationCount": 0,
      "redemptionCodeType": 0,
      "redemptionCode": "436346374",
      "redemptionBarcodeType": "QR_CODE"
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
couponId	String	Unique identifier of the coupon.
couponDesc	String	A brief text outlining the offer used in the list view of the offers.
couponInstanceId	String	Unique identifier of a instance of the coupon which is stored by a user.
locationCount	Integer
redemptionCodeType	Integer
redemptionCode	String	Code to redeem an coupon/offer.
redemptionBarcodeType	String	Type of barcode to redeem the coupon.

Get My Coupons

Retrieves the details of all valid coupons that an end user has saved. Supply search conditions, and the corresponding coupon information will be returned among the ones the end user saved. If you locally store coupon data in your app, you can sync coupon data using this API.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getMyCoupons/
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

View My Coupons Request

{
           "hideExpiredYn": "N"
}

Request Parameters

Parameter Name	Required	Type	Description
hideExpiredYn	No	String	Y returns coupons which have not been expired. N doesn’t check coupon expiry date and time. Default value is Y.

View My Coupons Response

{
  "result": {
    "code": 0
  },
  "couponList": [
    {
      "couponId": "816BA38D236244D2853FBB44E9B16526",
      "couponName": "3 Danishes for $5",
      "couponDesc": "3 Danishes for $5",
      "expiryDtim": "2019-12-31T17:00:00.000+0000",
      "brandId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "brandName": "Burger King",
      "brandImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "brandImageDtim": "2019-01-08T16:40:19.000+0000",
      "couponImageUrl": "http://api-dev.fintiv.co:8080/image/coupon/816BA38D236244D2853FBB44E9B16526_detail_xhdpi.png",
      "couponImageThumbUrl": "http://api-dev.fintiv.co:8080/image/coupon/816BA38D236244D2853FBB44E9B16526_list_xhdpi.png",
      "couponImageDtim": "2019-01-08T16:40:19.000+0000",
      "couponLongDesc": "3 Danishes for $5",
      "redemptionCodeType": 0,
      "redemptionCode": "436346374",
      "couponState": "ACTIVE",
      "locationList": [
        {
          "locationId": "8F18CFAF-DF38-4A7E-B541-7031E370ED3D",
          "locationName": "Burger King Alpharetta",
          "latitude": 34.04935,
          "longitude": -84.15855,
          "distance": 0,
          "addr1": "5025 Abbotts Bridge Rd",
          "city": "Alpharetta",
          "state": "GA",
          "country": "US",
          "zipCode": "30005",
          "openHours": [
            {
              "day": "MON",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "TUE",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "WED",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "THU",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "FRI",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "SAT",
              "open": "0600",
              "close": "2300"
            },
            {
              "day": "SUN",
              "open": "0600",
              "close": "2300"
            }
          ],
          "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
          "amenity": {
            "wifi": true,
            "driveThru": true,
            "mobilePay": true,
            "accessibility": true,
            "fullService": true,
            "specialVenue": false
          }
        }
      ],
      "recommendable": true,
      "featured": false,
      "categoryId": "200",
      "merchants": [],
      "legalStatement": "For limited time only.",
      "couponInstanceId": "8B3A98BB-7EB9-4B31-ACB9-D7000DE2D799",
      "nfcEnabled": false,
      "onlineEnabled": false,
      "redemptionBarcodeType": "QR_CODE"
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
couponId	String	Unique identifier of the coupon.
couponName	String	The simple name of the coupon.
couponDesc	String	A brief text outlining the offer used in the list view of the offers.
expiryDtim	string($date-time)	The date on which the coupon expires.Format is yyyy-MM-dd’T’HH:mm:ssZ
brandId	String	ID of the brand sponsoring the coupon
brandName	String	The name of the primary brand sponsoring the coupon.
brandImageUrl	String	URL of image of the brand
brandImageDtim	String	Timestamp that brand image is updated
couponImageUrl	String	URL of detail image of the coupon. Calling this URL returns the actual graphic of detail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageThumbUrl	String	URL of thumbnail image of the coupon. Calling this URL returns the actual graphic of thumbnail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageDtim	string($date-time)	Timestamp that coupon image is updated.Format is yyyy-MM-dd’T’HH:mm:ssZ
couponLongDesc	String	The full text describing the offer which may include purchase requirements and other terms and conditions
redemptionCodeType	integer
redemptionCode	String	Redemption code of the Coupon
couponState	String	State of coupon. Possible values are ACTIVE, INACTIVE, REDEEMED, EXPIRED, CREATED, PUBLISHED, UNPUBLISHED, DELETED
locationId	String	Unique identifier of location
locationName	String	Name of location.
latitude	number	Latitude of the location
longitude	number	Longitude of the location
distance	number	radius from latitude and longitude to find data in the range.
locationImageUrl	String	URL image of the Location
addr1	String	Street address of the location.
city	String	City of the location address
state	String	State of the location address
country	String	Country of the location address
zipCode	String	Zipcode of the location address
merchantId	String	Unique identifier of merchant
amenity	String	Identifier of the merchant associated with the location
wifi	boolean	Whether the location provides WIFI. Possible values are True or False
driveThru	boolean	Whether the location provides driveThru. Possible values are True or False
mobilePay	boolean	Whether the location provides mobilePay service. Possible values are True or False
accessibility	boolean	Whether the location provides accessibility.Possible values are True or False.
fullService	boolean	Whether the location provides full service.Possible values are True or False
specialVenue	boolean	Whether the location provides special venue.Possible values are True or False
couponInstanceId	String	Unique identifier of a instance of the coupon which is stored by a user

Get Coupon Detail

Retrieves the details of a coupon. Supply the unique coupon ID that was returned from your previous request, and the corresponding coupon information will be returned.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getCouponDetail
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Coupon Details Request

{
          "couponId": "9D564ADC253046F18341AB78512414FF"
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.
couponId	Yes	Double	Unique identifier of the coupon.

Get Coupon Details Response

{
  "couponId": "9D564ADC253046F18341AB78512414FF",
  "couponName": "Test coupon 021903",
  "couponDesc": "admin api test coupon",
  "expiryDtim": "2020-02-19T21:03:41.000+0000",
  "brandId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
  "brandName": "Burger King",
  "brandImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
  "brandImageDtim": "2019-02-19T21:59:39.000+0000",
  "couponImageUrl": "http://api-dev.fintiv.co:8080/image/coupon/9D564ADC253046F18341AB78512414FF_detail_xhdpi.png",
  "couponImageThumbUrl": "http://api-dev.fintiv.co:8080/image/coupon/9D564ADC253046F18341AB78512414FF_list_xhdpi.png",
  "couponImageDtim": "2019-02-19T21:59:39.000+0000",
  "couponLongDesc": "admin api test coupon",
  "recommendable": true,
  "featured": false,
  "distance": 0,
  "categoryId": "200",
  "merchants": [
    {
      "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "merchantName": "Burger King",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "merchantDtim": "2018-10-25T14:34:23.000+0000"
    }
  ],
  "legalStatement": "For limited time only",
  "nfcEnabled": false,
  "onlineEnabled": false,
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Type	Description
couponId	String	Unique identifier of the coupon.
couponName	String	The simple name of the coupon.
couponDesc	String	A brief text outlining the offer used in the list view of the offers.
expiryDtim	String	The date on which the coupon expires.Format is yyyy-MM-dd’T’HH:mm:ssZ
brandId	String	ID of the brand sponsoring the coupon
brandName	String	The name of the primary brand sponsoring the coupon.
brandImageUrl	String	URL of image of the brand
brandImageDtim	String	Timestamp that brand image is updated
couponImageUrl	String	URL of detail image of the coupon. Calling this URL returns the actual graphic of detail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageThumbUrl	String	URL of thumbnail image of the coupon. Calling this URL returns the actual graphic of thumbnail image to be displayed to the End User for the purpose of visual representation of the coupon.
couponImageDtim	String	Timestamp that coupon image is updated.Format is yyyy-MM-dd’T’HH:mm:ssZ
couponLongDesc	String	The full text describing the offer which may include purchase requirements and other terms and conditions.
recommendable	boolean	Whether the coupon can be recommendable or not
featured	boolean
distance	number	Distance between the requested position and the target location to redeem the offer
categoryId	String	ID of the category that the coupon is belonged.
merchants	String	Stores that the offer can be redeemed within the radius around location center. Location center is the latitude and longitude of the location requested from the client.
merchantsId	String	Unique identifier of merchant
merchantName	String	Name of merchant
merchantImageUrl	String	URL to retrieve merchant logo
merchantDtim	String	Date and time that merchant registered
legalStatement	String	The free form text that describes any rules or legal aspects related to the coupon in order to help the End User
nfcEnabeled	boolean	Has the value true if the offer supports NFC or the value false if the offer does not support NFC
onlineEnabled	boolean	Has the value true if the offer is available online or the value false if the offer is not available online

Get Coupons Redeemable Locations

Find all redeemable locations of a coupon. The returned locations can be filtered with search conditions.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getLocations
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Coupons Redeemable locations Request

{
               "couponId": "438285F3B17E43BBAFE8973B4B7B4F89",
               "latitude": 34.049348,
               "longitude": -84.158622,
               "maxDistance": 5,
               "maxResults": 10
      }

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.
couponId	Conditional	String	Unique identifier of the coupon to search locations. At least one of latitude, longitude or zipCode is needed to find locations.If merchantIds are in the request, coupondId is not required.
keyword	No	String	Search locations whose name has search keyword.
merchantIds	No	String	Identifier of merchant where the coupon can be redeemed. e.g. 1703276A-3709-45C5-B7EE- F5927D6D9EFA
latitude	Conditional Double	Latitude to find data in the range. e.g.34.044454912173904
longitude	Conditional	Double	Longitude to find locations in the range. e.g.-84.48063315578163
maxDistance	No	Double	radius from latitude and data to find locations in the range. Unit is km.e.g. 1000000
maxResults	No	Integer	Maximum number of data to be returned.

Get Coupons Redeemable locations Response

{
  "result": {
    "code": 0
  },
  "locationList": [
    {
      "locationId": "1657DEF9-5163-4DC4-A3BD-B80E30ED3ED5",
      "locationName": "Courtyard by Marriott Atlanta Duluth",
      "latitude": 34.049348,
      "longitude": -84.158622,
      "distance": 8.548130107105296e-16,
      "locationImageUrl": "http://api-dev.fintiv.co:8080/image/store/62B57113-34D3-4472-B811-CED3A490ABD8_xhdpi.png",
      "addr1": "3550 Venture Pkwy NW",
      "city": "Duluth",
      "state": "GA",
      "country": "US",
      "zipCode": "30096",
      "merchantId": "62B57113-34D3-4472-B811-CED3A490ABD8",
      "amenity": {
        "wifi": true,
        "driveThru": false,
        "mobilePay": false,
        "accessibility": true,
        "fullService": true,
        "specialVenue": false
      }
    },
    {
      "locationId": "F284B88E-0973-419B-8E2C-735A40B027C1",
      "locationName": "Courtyard by Marriott Atlanta Buford",
      "latitude": 34.049352,
      "longitude": -84.158626,
      "distance": 0.0005776515881442754,
      "locationImageUrl": "http://api-dev.fintiv.co:8080/image/store/62B57113-34D3-4472-B811-CED3A490ABD8_xhdpi.png",
      "addr1": "1405 Mall of Georgia Blvd",
      "city": "Buford",
      "state": "GA",
      "country": "US",
      "zipCode": "30519",
      "merchantId": "62B57113-34D3-4472-B811-CED3A490ABD8",
      "amenity": {
        "wifi": true,
        "driveThru": false,
        "mobilePay": true,
        "accessibility": true,
        "fullService": true,
        "specialVenue": false
      }
    }
  ]
}

Response Parameters

Parameter Name	Type	Description

Redeem Coupons

Notifies the services that the coupon is redeemed in order to update coupon instance state.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/reportCouponRedemption
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Redeem Coupons Request

{
     "redeemCouponList":
                       [ {
                  "couponId":"9D564ADC253046F18341AB78512414FF",
                  "couponInstanceId" : "71722408-490C-4138-A211-E204BFD9A36B",
                  "redeemDtim": "2018-05-16T21:25:50.000-0500"
                        } ],
      "serviceId": "10522"
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier of coupon service.
redeemCouponList	Yes	List	List of information of coupons redeemed.
couponId	No	String	Unique identifier of the coupon.
couponInstanceId	Yes	String	Unique identifier of an instance of the coupon which is stored by a user e.g. B1BE03DD-CAE1-49E4-972A-6B13E7A0CBB4
redeemDtim	No	String	Coupon redemption date/time. If value is not set, current date and time is set. Format is yyyy-MM-dd’T’HH:mm:ssZ yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 Z: RFC 822 time zone, e.g. -0800 e.g. “2019-02-08T14:23:35.443-0500”

Redeem Coupons Response

{
  "result": {
    "code": 0
}
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Response code

Remove my Coupons

This API removes a coupon from user's saved coupon list. Supply the unique coupon ID that was returned from your previous request.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/removeMyCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Remove My Coupons Request

{
  "couponInstanceIdList": [
    "9B6EEFD7D5ED483D91F5EFEA59CEF242"
  ],
  "serviceId": 10522
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.
couponInstanceIdList	Yes	String	List of coupon instance IDs to be removed. e.g.["71722408-490C-4138-A211-E204BFD9A36B”]

Remove My Coupons Response

{
  "result": {
    "code": 0,
    "message": "string"
  }
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Response code
message	String

Recommend Coupon

Retrieves the recommendation URL of a coupon. Use the unique coupon ID that was returned from your previous request, and the recommended URL of the coupon will be returned. The receiver can download and save the coupon by calling the recommendation URL.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/recommendCoupon
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Recommend Coupon Request

{
    "couponId": "ECBAEFD32C244CB79FD1631881C99D98",
    "serviceId": 10515
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.
couponId	Yes	String	Unique identifier of the coupon.

Recommend Coupon Response

{
  "result": {
    "code": 0
  },
  "recommendUrl": "http://dev-mcpserver.int.mozido.com/corpay/ci/coupon/v2/share/entry/10522/ECBAEFD32C244CB79FD1631881C99D98"
}

Response Parameters

Parameter Name	Type	Description
recommendUrl	string	Recommendation URL of a coupon
code	integer	Response code
message	string

Deactivate Coupons

Set the status of one or more coupon instances to inactive. Supply the unique coupon instance ID that was returned from previous 'View my coupons' request.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/deactivateCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Deactivate Coupons Request

{
           "couponInstanceIdList": ["71722408-490C-4138-A211-E204BFD9A36B"]
}

Request Parameters

Name	Required	Description	Value/Range
serviceId	No	Unique identifier for the offer service.	String
couponInstanceIdList	Yes	List of coupon instance IDs to be updated. e.g.["71722408-490C-4138-A211-E204BFD9A36B”]	String[]

Deactivate Coupons Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	Integer
message		string

Activate Coupons

Set the status of one or more coupon instances to active. Supply the unique coupon instance ID that was returned from previous 'View my coupons' request.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/activateCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Activate Coupons Request

{
           "couponInstanceIdList": ["71722408-490C-4138-A211-E204BFD9A36B"]
}

Request Parameters

Name	Required	Description	Value/Range
serviceId	No	Unique identifier for the offer service.	String
couponInstanceIdList	Yes	List of coupon instance IDs to be updated. e.g.["71722408-490C-4138-A211-E204BFD9A36B”]	String[]

Activate Coupons Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	response code	Integer
message		string

Get Favorite Merchant

Retrieve end user’s list of favorite merchants.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getFavoriteMerchant
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Favorite Merchants Request

{}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.

Get Favorite Merchants Response

{
  "result": {
    "code": 0
  },
  "merchantIds": [
    "80277822-10DA-4829-8708-7636DED7944C"
  ]
}

Response Parameters

Parameter Name	Type	Description
merchantIds	String	Identifier of merchant where the coupon can be redeemed.
code	integer	Response code
message	String

Advertisement

Get Ad

Retrieves published advertisements and all details for displaying advertisements to the end users.

Key	Value
Method	POST
Resource URL	{Ad_URL}/v4/getAd
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Ad Request

{
                "imageDisplayTypeCd": "BANNER"
}

Request Parameters

Name	Required	Description	Value/Range
imageDisplayTypeCd	no	An enumerated value providing type of image to be displayed in end user’s mobile device. Possible values are FULLPAGE, and BANNER. The value FULLPAGE indicates the image displayed in the full screen of mobile device. The value BANNER indicates the image displayed as the banner form in the screen.	String

Get Ad Response

{
  "result": {
    "code": 0
  },
  "walletId": "JANUS",
  "adId": "FBDEA99C2F464C0BB9A78B766E43B95C",
  "adLink": "https://google.com",
  "clickActionTypeCd": "OPENURL",
  "imageDisplayTypeCd": "BANNER",
  "imageInfoList": [
    {
      "imageUrl": "http://api-dev.fintiv.co:8080/image/advrt/FBDEA99C2F464C0BB9A78B766E43B95C_B_PX_720X100.png",
      "imageSize": "B_PX_720X100"
    },
    {
      "imageUrl": "http://api-dev.fintiv.co:8080/image/advrt/FBDEA99C2F464C0BB9A78B766E43B95C_B_PX_640X100.png",
      "imageSize": "B_PX_640X100"
    }
  ],
  "updDtim": "2018-12-14T02:43:54.000+0000"
}

Response Parameters

Parameter Name	Description	Value/Range
code	Response code	integer
adId	Unique identifier for the advertisement.	string
adLink	URL or Phone number referred by clkckActionTypeCd when the end user clicks the advertisement	String
clickActionTypeCd	An enumerated value providing type of action to be occurred when the end user clicks the advertisement image in the application. Possible values are · DONOTHING : No action occurred · OPENURL: Open the URL in adLink in the browser · PHONECALL: Make a phone call to the phone number in adLink · SENDTEXT: Send text massage to the phone number in adLink.	string
imageDisplayTypeCd	Possible values-BANNER or FULLPAGE	string
imageInfoList	A list of images associated with this Advertisement.	string
updDtim	Last updated date and time of the advertisement.	string(date-time)

Store end user’s activity with the advertisement in the server when the user clicks the link of advertisement.

Key	Value
Method	POST
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Ad Click Request

Report the user action when the link of advertisement is clicked.

{
        "adId":"FBDEA99C2F464C0BB9A78B766E43B95C",
        "clickDtim":"2018-02-11T12:56:28.000-0500"
}

Request Parameters

Name	Required	Description	Value/Range
adId	yes	Unique identifier for the advertisement.	String
clickDtim	yes	Date and time the end user clicked the link of the advertisement. Format is yyyy-MMdd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Date

Report Ad Click Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	integer
message		string

Report Ad View

Store end user’s activity with the advertisement in the server when the user views the advertisement.

Key	Value
Method	POST
Resource URL	{Ad_URL}/v4/reportAdView
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Ad View Request

{
            "adId": "FBDEA99C2F464C0BB9A78B766E43B95C",
            "serviceId": 10516,
            "viewDtim": "2018-02-11T12:56:28.000-0500"
}

Request Parameters

Parameter Name	Required	Description	Value/Range
adId	yes	Unique identifier for the advertisement.	String
viewDtim	yes	Date and time the end user clicked the link of the advertisement. Format is yyyy-MMdd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Date

Report Ad View Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Description	Value/Range
code	Response code	integer
message		string

Campaign

Get Geo-fencing Campaign List

Retrieves your pre-defined list of geofencing based campaigns.

Key	Value
Method	POST
Resource URL	{Campaign_URL}/v4/getGeofencingCampaignList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameters

Key	Value
Content-Type	application/json
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Geofencing Campaign List Request

{

}

Request Parameters

None.

Geofencing Campaign List Response

{
  "result": {
    "code": 0
  },
  "geofencingCampaignList": [
    {
      "campaignId": "38ADC18674E344888F6EBB557E328395",
      "geofenceInfoList": [
        {
          "lat": 0,
          "lon": 0,
          "distance": 1
        },
        {
          "lat": 34.0452953,
          "lon": -84.33333379999999,
          "distance": 1
        }
      ]
    }
  ]
}

Response Parameters

Name	Description	Value/Range
code	Response code	String
campaignId	Identifier of the campaign	String

Report Entering Campaign Areas

Client manages and monitor geofencing information of campaign. If the end user enters into the geofencing location, the client detects and reports the event to the server. Then the server will publish the associated campaign to the end user.

Key	Value
Method	POST
Resource URL	{Campaign_URL}/v4/reportEnteringCampaignArea
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Entering Campaign Areas Request

Report the event that end user enters into the location of campaign.

{
             "campaignIdList": ["38ADC18674E344888F6EBB557E328395"],
             "eventDtim": "2019-02-16T00:00:00.000-0500"
}

Request Parameters

Parameter Name	Required	Description	Value/Range
campaignIdList	yes	Identifier of the campaign e.g. 38ADC18674E344888F6EBB557E328395.	Double
eventDtim	yes	Event occurred date/time Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Double

Report Entering Campaign Areas Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	String

Report Campaign Event

Client manages and monitor beacon and promotion code information of campaign. If it detects a beacon ID or that the end user used a promotion code, the client detects and reports the event to the server. Then the server will publish the associated campaign to the end user.

Key	Value
Method	POST
Resource URL	{Campaign_URL}/v4/reportCampaignEvent
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameters

Key	Value
Content-Type	application/json
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	API-Key
Authorization	Bearer {sub_token}

Report Campaign Event Request Report the event that beacon detected or promotion code used.

{
             "eventValue": "HAPPYMOM",
             "eventValueType": "PROMO_CODE"
}

Request Parameters

Name	Required	Description	Value/Range
eventValue	yes	Value of event. e.g. Actual value of Beacon ID or promotion code.	String
eventValueType	yes	Type of event. Possible values are BEACON_ID and PROMO_CODE	String

Report Campaign Event Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	String

Digital Stamps

Get Stamp Catalog

Retrieves list of available stamps in the search conditions.

Key	Value
Method	Post
Resource URL	{Stamp_URL}/v4/getRewards
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Stamp Catalog Request

{
    "latitude": 34.044454912173904,
    "longitude": -84.48063315578163,
    "maxResults": 20,
    "radius": 100000,
    "merchantIds": ["1467250E-1CB1-40F4-85B2-85C5BE4EB0A0"],
    "serviceId":"10520",
    "skipRows": 0,
    "stampCardId":"1F7C3F59-2478-44DD-8059-6E6969542099"
}  

Request Parameters

Parameter Name	Required	Description	Value/Range
serviced	no	Unique identifier of your subscribing digital stamp service. e.g. 10520	String
latitude	no	Latitude to find data in the range example: 34.044454912173904	Double
longitude	no	Longitude to find data in the range example: -84.48063315578163	Double
radius	no	radius from latitude and longitude to find data in the range. Unit is km. example: 1000000	Double
skipRows	no	Starting row of data in the list being requested. For example, 2 is set, the first two rows will be skipped. Along with maxRows, you can use this for pagination.	int
maxResults	no	Maximum number of data to be returned. Along with skipRows, you can use this for pagination. e.g. 5 returns up to 5 coupons.	int
merchantIds	no	Identifier of merchant who associated with the digital stamp service. e.g. 1703276A-3709-45C5-B7EE-F5927D6D9EFA	String
stampCardId	no	Identifier of a stamp card	String

Get Stamp Catalog Response

{
  "result": {
    "code": 0
  },
  "catalog": [
    {
      "stampCardId": "1F7C3F59-2478-44DD-8059-6E6969542099",
      "name": "Coffee House",
      "stampType": "QR",
      "stampCount": 0,
      "phoneNumber": "2024419862",
      "isPublishToMarket": "N",
      "backgroundImageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/1F7C3F59-2478-44DD-8059-6E6969542099_bg_xhdpi.png",
      "stampAreaImageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/1F7C3F59-2478-44DD-8059-6E6969542099_stamp_xhdpi.png",
      "rewards": [
        {
          "rewardId": "F175099B-C54D-4BC8-B567-6DFEADD50ED5",
          "serviceId": "10520",
          "name": "Free Coffee",
          "threshold": 5,
          "imageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/F175099B-C54D-4BC8-B567-6DFEADD50ED5_reward_xhdpi.png",
          "rewardMessage": "Congratulations, this on is on us!",
          "rewardDescription": "Free Coffee"
        }
      ],
      "merchant": {
        "merchantId": "1467250E-1CB1-40F4-85B2-85C5BE4EB0A0",
        "merchantName": "Coffee House",
        "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/1467250E-1CB1-40F4-85B2-85C5BE4EB0A0_xhdpi.png",
        "updateDtim": "2018-12-19T17:42:26.000+0000",
        "store": {
          "storeId": "2A439A70-B572-45EF-BE50-2D900E4B64DA",
          "storeName": "Coffee House - Alpharetta",
          "street1": "12600 Deerfield Parkway Suite 425",
          "city": "Alpharetta",
          "state": "Georgia",
          "zip": "30004",
          "country": "US",
          "latitude": 34.089487,
          "longitude": -84.270758,
          "distance": 19.971244473406266
        }
      }
    }
  ]
}

Response Parameters

Name	Value/Range	Description
catalog	string
stampCardId	string	Unique identifier of the stamp card
name	string	Name of the stamp card e.g. Burger King Alpharetta
stampType	string	Unique identifier of the merchant who issued the membership card. Possible values are QR: QR Code,NFC: NFC Tag,STAMP: Physical Stamp e.g. QR
stampCount	string	Number of stamps available in the stamp card. e.g. 5
phoneNumber	string	Customer care phone number
isPublishToMarket	string	To publish this stamp card to digital stamp marketplace. Possible values are Y,N
backgroundImageUrl	string	URL of background image of the stamp card
stampAreaImageUrl	string	URL of stamp image on the stamp card.
rewards	string	List of rewards associated with the stamp card
rewardId	string	Unique identifier of the reward provided as an award after end user achieves the goal of the stamp card.
serviceId	string	Unique identifier of your subscribing digital stamp card service
threshold	string	The number of stamps needed to earn this reward. This value is same as the number of stamps in the stamp object. e.g.10
imageUrl	string	Reward image URL
rewardMessage	string	Customer message when the customer earned required all stamps and eligible to get the reward.
rewardDescription	string	Short description of the reward
merchantId	string	Unique identifier of the merchant whose stores will be associated with the stamp card.
merchantName	string	Name of the merchant
merchantImageUrl	string	URL of merchant logo image
updateDtim	string	Last update date time of this merchant.
storeId	string	Unique identifier of the store
storeName	string	Name of the store
code	integer

Add Stamp Card

End user adds the stamp card in his/her wallet. Supply the identifier of the stamp card and end user’s stamp card instance will be created.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/addCard
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Add Card Request

End user adds digital stamp card in his/her wallet.

{
  "stampCardId":"1F7C3F59-2478-44DD-8059-6E6969542099"
}    

Request Parameters

Name	Required	Description	Value/Range
stampCardId	yes	Unique identifier of the stamp card e.g. 0616DE94-DED7-4D51-B766-2203296654FB	String

Add Card Response

End user adds digital stamp card to their wallet.

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	integer
message		string

Get Stamp Cards

End user find their digital stamp card instances by search conditions.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/getCards
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Card Request

End user retrieves his/her digital stamp card.

{
  "latitude":34.044454912173904,"longitude": -84.48063315578163,"radius": 10000,"sortType": 4
}   

Request Parameters

Parameter Name	Required	Description	Value/Range
latitude	no	Latitude to find data in the range example: 34.044454912173904	Double
longitude	no	Longitude to find data in the range example: -84.48063315578163	Double
radius	no	radius from latitude and longitude to find data in the range. Unit is km. example: 1000000	Double
sortType	no	Define how to sort the returned data. Default is 0. Possible values are: - 0 to not sort data. - 1 to sort data by merchant name with A to Z order - 2 to sort data by merchant name with Z to A order - 3 to sort data by distance with the nearest location appearing first. - 4 to sort data by distance with the farthest location appearing first. - 5 to sort data by its usage with the most frequently used one first. - 6 to sort data by its usage with the least used one first. - 7 to sort data by the sequence that the end user defined using updateCardSequences()	int

Get Cards Response

{
  "result": {
    "code": 0
  },
  "cards": [
    {
      "cardInstanceId": "0131cef8-56e1-461a-b82b-7e220b925481",
      "stampCardId": "9708557D-73F2-4C5E-AA61-90AE0919B6C1",
      "currentStamps": 0,
      "totalStamps": 0,
      "issueDate": "2019-03-14T13:48:09.094+0000",
      "expirationDate": "2019-07-01T03:59:59.000+0000",
      "status": "ACTIVE"
    },
    {
      "cardInstanceId": "4cd8ef60-719a-43bf-8d91-6c8d4be24a2d",
      "stampCardId": "1F7C3F59-2478-44DD-8059-6E6969542099",
      "currentStamps": 0,
      "totalStamps": 0,
      "issueDate": "2019-03-14T13:44:49.025+0000",
      "expirationDate": "2021-01-01T04:59:59.000+0000",
      "status": "ACTIVE"
    }
  ]
}

Response Parameters

Parameter Name	Value/Range	Description
cardInstanceId	string	End user’s card instance ID
stampCardId	string	Unique identifier of the stamp card
currentStamps	integer	The number of stamp the end user collects
totalStamps	integer	Number of stamps available in the stamp card.
issueDate	string	Date and time that end user created the stamp card instance.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
expirationDate	string	Date and time that the stamp card expires.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
status	string	Status of the digital stamp card instance.
code	integer	Response code
message	string

Get Stamp Merchants

Find and sort merchants by search conditions.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/getMerchants
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Stamp Merchants Request

Retrieve merchants who provides digital stamp service with search conditions.

{
    "latitude": 34.044454912173904,
    "longitude": -84.48063315578163,
    "radius": 10000,
    "searchType": 1
}

Request Parameters

Name	Required	Description	Value/Range
Latitude	no	Latitude to find coupons in the range example: 34.044454912173904	Double
longitude	no	Longitude to find coupons in the range example: -84.48063315578163	Double
radius	no	radius from latitude and longitude to find data in the range. Unit is km. example: 1000000	Double
merchantName	no	Name of the merchant who provides the digital stamp card service.	String
searchType	no	Define how to sort the returned data. Default is 0. Possible values are: - 0 to return all data. - 1 to sort data by distance, with the nearest merchant appearing first. - 2 to sort data by name, with the A to Z order.	int

Get Stamp Merchants Response

{
  "result": {
    "code": 0
  },
  "merchants": [
    {
      "merchantId": "1467250E-1CB1-40F4-85B2-85C5BE4EB0A0",
      "merchantName": "Coffee House",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/1467250E-1CB1-40F4-85B2-85C5BE4EB0A0_xhdpi.png",
      "updateDtim": "2018-12-19T17:42:26.000+0000"
    },
    {
      "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "merchantName": "Burger King",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/store/B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A_xhdpi.png",
      "updateDtim": "2018-10-25T14:34:23.000+0000"
    }
  ]
}

Response Parameters

Name	Value/Range	Description
merchantId	string	Unique identifier of the merchant whose stores will be associated with the stamp card.
merchantName	string	Name of the merchant e.g. Burger King
merchantImageUrl	string	URL of merchant logo image.
updateDtim	string	Last update date time of this merchant.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
code	integer	Response Code
message	string

Get Stamps

Retrieve stamp master data of the stamp card to add the stamp in the end user’s stamp card instance.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/getStamps
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Stamps Request

Get stamp master data of the stamp card.

{"stampCardId":"0616DE94-DED7-4D51-B766-2203296654FB"}

Request Parameters

Parameter Name	Required	Description	Value/Range
stampCardId	yes	Unique identifier of the stamp card e.g. 0616DE94-DED7-4D51-B766-2203296654FB	String

Get Stamps Response

{
  "result": {
    "code": 0
  },
  "stamps": [
    {
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "stampState": "ACTIVE",
      "awardStamps": 0,
      "rewardId": "68B3D3E6-E681-482D-9797-89D517DDA94E",
      "stampEventType": "REDEEM"
    }
  ]
}

Response Parameters

Parameter Name	Value/Range	Description
stampId	string	Unique identifier of the reward to be earned by this event.
stampValue	string	A code to explicitly validate the reward redemption.
stampState	string	Status of the stamp
awardStamps	integer
rewardId	string	Unique identifier of the reward provided as an award after end user achieves the goal of the stamp card.
stampEventType	string	event type of the stamp
code	integer	response code
message	string

Report Stamp Event

Add a stamp event to an end user’s stamp card instance.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/reportStampEvent
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Stamp Event Request

Add a stamp event in end user’s stamp card instance.

{
    "cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54",
    "eventTime":"2019-03-14T14:30:03.278-0000",
    "eventType":"STAMP",
    "rewardInstanceId":"68B3D3E6-E681-482D-9797-89D517DDA94E",
    "stampValue":"GZ23-A457-Z50-E56X-O23G"
}

Request Parameters

Name	Required	Description	Value/Range
cardInstanceId	no	Unique identifier of the end user’s stamp card instance e.g. 0131cef8-56e1-461a-b82b-7e220b925481	String
eventTime	yes	Date and time that the event occurs. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Date
eventType	yes	Type of the event. Possible values are: - STAMP - REDEEM - REWARD - REMOVE_STAMP - REMOVE_REWARD	String
rewardInstanceId	yes	Unique identifier of the reward to be earned by this event.	String
stampValue	yes	A code to explicitly validate the reward redemption. e.g. GZ23-A457-Z50-E56X-O23G	String

Report Stamp Event Response

{
  "result": {
    "code": 0
  },
  "cardInstance": {
    "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
    "stampCardId": "0616DE94-DED7-4D51-B766-2203296654FB",
    "currentStamps": 1,
    "totalStamps": 0,
    "issueDate": "2019-03-14T14:19:04.141+0000",
    "updateTime": "2019-03-14T14:38:14.570+0000",
    "expirationDate": "2030-03-14T03:59:59.000+0000",
    "status": "ACTIVE",
    "rewards": []
  },
  "rewards": []
}

Response Parameters

Parameter Name	Value/Range	Description
cardInstanceId	string	Unique identifier of the end user’s stamp card instance.
stampCardId	string	Unique identifier of the stamp card.
currentStamps	integer	The number of stamp the end user collects
totalStamps	integer	Number of stamps available in the stamp card.
issueDate	string	Date and time that end user created the stamp card instance.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
updateTime	string	Date and time when end user stamp card instance is updated
expirationDate	string	Date and time that the stamp card expires.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
status	string	Status of the digital stamp card instance.
code	integer	Response code
message	string

Report Multiple Stamp Events

An end user collects multiple stamps on their stamp card instance.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/reportMultiStampEvents
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Multiple Stamp Events Request

Add multiple stamp events in end user’s stamp card instance. Request

{
"events": [
    {
        "eventId":"1",
        "cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54",
        "eventTime":"2019-03-14T18:30:03.278-0000",
        "eventType":"STAMP",
        "rewardInstanceId":"68B3D3E6-E681-482D-9797-89D517DDA94E",
        "stampValue":"GZ23-A457-Z50-E56X-O23G"
    },
    {
        "eventId":"2",
        "cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54",
        "eventTime":"2019-03-14T19:30:03.278-0000",
        "eventType":"STAMP",
        "rewardInstanceId":"68B3D3E6-E681-482D-9797-89D517DDA94E",
        "stampValue":"GZ23-A457-Z50-E56X-O23G"
    }
]
}

Request Parameters

Name	Required	Description	Value/Range
events	yes	List of events.	Double

Event Object Body Parameters

Name	Required	Description	Value/Range
cardInstanceId	no	Unique identifier of the end user’s stamp card instance e.g. 0131cef8-56e1-461a-b82b-7e220b925481.	String
eventId	yes	Unique identifier of the event defined by the client for the server to distinguish the request and return the result e.g. eventId0321-011, 1, etc.	String
eventTime	yes	Date and time that the event occurs. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Date
eventType	yes	Type of the event. Possible values are: - STAMP - REDEEM - REWARD - REMOVE_STAMP - REMOVE_REWARD	String
rewardInstanceId	yes	Unique identifier of the reward to be earned by this event.	String
stampValue	yes	A code to explicitly validate the reward redemption. e.g. GZ23-A457-Z50-E56X-O23G	String

Report Multiple Stamp Events Response

When all requests were successful.

{
  "result": {
    "code": 0
  },
  "eventResults": [
    {
      "result": {
        "code": 0
      },
      "eventId": "1",
      "cardInstance": {
        "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
        "stampCardId": "0616DE94-DED7-4D51-B766-2203296654FB",
        "currentStamps": 1,
        "totalStamps": 0,
        "issueDate": "2019-03-14T14:19:04.141+0000",
        "updateTime": "2019-03-14T17:37:37.149+0000",
        "expirationDate": "2030-03-14T03:59:59.000+0000",
        "status": "ACTIVE",
        "rewards": []
      },
      "rewards": [
        {
          "rewardInstanceId": "71584867-2b99-4d76-b628-dbb8526f66b7",
          "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
          "reward": {
            "rewardId": "68B3D3E6-E681-482D-9797-89D517DDA94E",
            "walletId": "JANUS",
            "serviceId": "10520",
            "name": "Test stamp reward 0301-01",
            "threshold": 5,
            "imageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/68B3D3E6-E681-482D-9797-89D517DDA94E_reward_xhdpi.png",
            "rewardMessage": "reward message test",
            "rewardDescription": "reward description"
          },
          "status": "ACTIVE",
          "rewardedTime": "2019-03-14T17:37:37.103+0000",
          "rewardExpirationDate": "2019-04-13T17:37:37.103+0000"
        }
      ]
    },
    {
      "result": {
        "code": 0
      },
      "eventId": "2",
      "cardInstance": {
        "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
        "stampCardId": "0616DE94-DED7-4D51-B766-2203296654FB",
        "currentStamps": 1,
        "totalStamps": 0,
        "issueDate": "2019-03-14T14:19:04.141+0000",
        "updateTime": "2019-03-14T17:37:37.149+0000",
        "expirationDate": "2030-03-14T03:59:59.000+0000",
        "status": "ACTIVE",
        "rewards": []
      },
      "rewards": []
    }
  ]
}

Report Multiple Stamp Events Response

When both a successful and a failed request exist.

{
  "result": {
    "code": 0
  },
  "eventResults": [
    {
      "result": {
        "code": 33003,
        "message": "stamp.multiple.stamp.attempt"
      },
      "eventId": "1"
    },
    {
      "result": {
        "code": 0
      },
      "eventId": "2",
      "cardInstance": {
        "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
        "stampCardId": "0616DE94-DED7-4D51-B766-2203296654FB",
        "currentStamps": 4,
        "totalStamps": 0,
        "issueDate": "2019-03-14T14:19:04.141+0000",
        "updateTime": "2019-03-14T17:46:44.173+0000",
        "expirationDate": "2030-03-14T03:59:59.000+0000",
        "status": "ACTIVE",
        "rewards": [
          {
            "rewardInstanceId": "71584867-2b99-4d76-b628-dbb8526f66b7",
            "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
            "reward": {
              "rewardId": "68B3D3E6-E681-482D-9797-89D517DDA94E",
              "walletId": "JANUS",
              "serviceId": "10520",
              "name": "Test stamp reward 0301-01",
              "threshold": 5,
              "imageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/68B3D3E6-E681-482D-9797-89D517DDA94E_reward_xhdpi.png",
              "rewardMessage": "reward message test",
              "rewardDescription": "reward description"
            },
            "status": "ACTIVE",
            "rewardedTime": "2019-03-14T17:37:37.103+0000",
            "rewardExpirationDate": "2019-04-13T17:37:37.103+0000"
          }
        ]
      },
      "rewards": []
    }
  ]
}

Report Multiple Stamp Events Response

When all request failed.

{
  "result": {
    "code": 0
  },
  "eventResults": [
    {
      "result": {
        "code": 33003,
        "message": "stamp.multiple.stamp.attempt"
      },
      "eventId": "1"
    },
    {
      "result": {
        "code": 33003,
        "message": "stamp.multiple.stamp.attempt"
      },
      "eventId": "2"
    }
  ]
}

Response Parameters

Parameter Name	Value/Range	Description
eventId	string	Unique identifier of the event defined by the client for the server to distinguish the request and return the result e.g. eventId0321-011, 1, etc.
stampCardId	string	Unique identifier of the stamp card
currentStamps	integer	The number of stamp the end user collects
totalStamps	integer	Number of stamps available in the stamp card.
issueDates	string	Date and time that end user created the stamp card instance.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
updateTime	string	Last update date time of the stamp card
expirationDate	string	Date and time that the stamp card expires.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
status	string	Status of the digital stamp card instance.
rewardInstanceId	string	Unique identifier of the reward to be earned by this event.
cardInstanceId	string	End user’s card instance ID
rewardId	string	Unique identifier of the reward provided as an award after end user achieves the goal of the stamp card.
walletId	string	Your tenant’s ID
serviceId	string	Unique identifier of your subscribing digital stamp card service e.g. 10520
name	string	Name of the reward program e.g. Burger King’s rewards
threshold	integer	The number of stamps needed to earn this reward. This value is same as the number of stamps in the stamp object. e.g.10
imageUrl	string	Reward image.
rewardMessage	string	Customer message when the customer earned required all stamps and eligible to get the reward.
rewardDescription	string	Short description of the reward
rewardedTime	string	Date and time that the reward instance is created.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
rewardExpirationDate	string	Date and time that the reward instance expires.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
code	integer	response code
message	string

Get Rewards

End user earns rewards after collecting the required stamps. Retrieve all the end user’s available rewards.

Key	Value
Method	Post
Resource URL	{Stamp_URL}/v4/getRewards
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Rewards Request

{"cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54"}

Request Parameters

Parameter Name	Required	Description	Value/Range
cardInstanceId	no	Unique identifier of the end user’s stamp card instance e.g. 0131cef8-56e1-461a-b82b-7e220b925481	String

Get Rewards Response

{
  "result": {
    "code": 0
  },
  "rewards": [
    {
      "rewardInstanceId": "71584867-2b99-4d76-b628-dbb8526f66b7",
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "reward": {
        "rewardId": "68B3D3E6-E681-482D-9797-89D517DDA94E",
        "walletId": "JANUS",
        "serviceId": "10520",
        "name": "Test stamp reward 0301-01",
        "threshold": 5,
        "imageUrl": "http://api-dev.fintiv.co:8080/image/stampcard/68B3D3E6-E681-482D-9797-89D517DDA94E_reward_xhdpi.png",
        "rewardMessage": "reward message test",
        "rewardDescription": "reward description"
      },
      "status": "ACTIVE",
      "rewardedTime": "2019-03-14T17:37:37.103+0000",
      "rewardExpirationDate": "2019-04-13T17:37:37.103+0000"
    }
  ]
}

Response Parameters

Parameter Name	Value/Range	Description
rewardInstanceId	string	Unique identifier of the reward to be earned by this event.
cardInstanceId	string	End user’s card instance ID
rewardId	string	Unique identifier of the reward provided as an award after end user achieves the goal of the stamp card.
walletId	string	Your tenant’s ID
serviceId	string	Unique identifier of your subscribing digital stamp card service e.g. 10520
name	string	Name of the reward program e.g. Burger King’s rewards
threshold	integer	The number of stamps needed to earn this reward. This value is same as the number of stamps in the stamp object. e.g.10
imageUrl	string	Reward image URL
rewardMessage	string	Customer message when the customer earned required all stamps and eligible to get the reward.
rewardDescription	string	Short description of the reward.
status	string	Status of the reward instance.
rewardedTime	string	Date and time that the reward instance is created.Format is yyyy-MM-dd’T’HH:mm:ss.SZ.
RewardExpirationDate	string	Date and time that the reward instance expires.Format is yyyy-MM-dd’T’HH:mm:ss.SZ.
code	integer	response code
message	string

Update Stamp Card Sequence

End user defines the display sequence of stamp cards in their wallet.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/updateCardSequences
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Update Card Sequence Request

{
"updateCardSeqList": [
       {"cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54","sequence":3},
       {"cardInstanceId":"4cd8ef60-719a-43bf-8d91-6c8d4be24a2d","sequence": 2},
       {"cardInstanceId":"0131cef8-56e1-461a-b82b-7e220b925481","sequence": 1 }
] }

Request Parameters

Name	Required	Description	Value/Range
updateCardSeqList	yes	Unique identifier for the offer service.	String
Child attribute
cardInstanceId	yes	Unique identifier of the end user’s stamp card instance. e.g. 0131cef8-56e1-461a-b82b-7e220b925481	String
sequence	yes	Card display sequence.	int

Update Card Sequence Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Value/Range	Description
code	integer	Response code
message	string

Get Card Event History

Supply card instance ID and retrieve all events associated with the card instance.

Key	Value
Method	Post
Resource URL	{Stamp_URL}/v4/getEventHistory
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Event History Request

Retrieve all events of the end user’s digital stamp card instance.

{"cardInstanceId":"3ab8fd17-2fb5-468c-9079-dfb887aacc54"}

Request Parameters

Parameter Name	Required	Description	Value/Range
cardInstanceId	yes	Unique identifier of the end user’s stamp card instance e.g. 0131cef8-56e1-461a-b82b-7e220b925481	String

Get Event History Response

{
  "result": {
    "code": 0
  },
  "events": [
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T21:32:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T21:30:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T20:30:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T19:30:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T18:30:04.278+0000",
      "eventType": "REWARD",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "71584867-2b99-4d76-b628-dbb8526f66b7"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T18:30:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    },
    {
      "cardInstanceId": "3ab8fd17-2fb5-468c-9079-dfb887aacc54",
      "eventTime": "2019-03-14T17:30:03.278+0000",
      "eventType": "STAMP",
      "stampId": "450CEE46-4E66-4C37-A095-5C3D7B661A23",
      "stampValue": "GZ23-A457-Z50-E56X-O23G",
      "rewardInstanceId": "68B3D3E6-E681-482D-9797-89D517DDA94E"
    }
  ]
}

Response Parameters

Name	Description	Value/Range
cardInstanceId	End user’s card instance ID	string
eventTime	Date and time that the event occurs.Format is yyyy-MM-dd’T’HH:mm:ss.SZ	string
eventType	Type of the event. Possible values are STAMP,REDEEM,REWARD,REMOVE_STAMP,REMOVE_REWARD	string
stampId	Unique identifier of the reward to be earned by this event.	string
stampValue	A code to explicitly validate the reward redemption	string
rewardInstanceId	A code to explicitly validate the reward redemption.	string
code	response code	integer
message		string

Remove a Stamp Card

Client retrieves a list of skins configured on the backend.

Key	Value
Method	POST
Resource URL	{Stamp_URL}/v4/removeCard
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Remove Card

End user removes a digital stamp card Request.

{"cardInstanceId":"0131cef8-56e1-461a-b82b-7e220b925481"}

Request Parameters

Name	Required	Description	Value/Range
cardInstanceId	yes	Unique identifier of the end user’s stamp card instance e.g. 0131cef8-56e1-461a-b82b-7e220b925481	String

End user removes a digital stamp card Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Description	Value/Range
code	response code	integer
message		string

Inbox

Get Inbox Message List

Retrieve list of inbox messages. If the end user not opt in the marketing message, no marketing messages will be returned.

Key	Value
Method	POST
Resource URL	{Inbox_URL}/v4/getInboxMessageList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Inbox Message List Request

{}

Request Parameters

Name	Required	Description	Value/Range
lastMessageId	no	Returns message created after this message ID.	String
messageType	no	Type of message. Possible values are SERVICE and MARKETING.	String
maxResults	no	Maximum number of data to be returned. Along with skipRows, you can use this for pagination. e.g. 5 returns up to 5 coupons.	int
skipRows	no	Starting row of data in the list being requested. For example, 2 is set, the first two rows will be skipped. Along with maxRows, you can use this for pagination.	int

Get Inbox Message List Response

{
  "result": {
    "code": 0
  },
  "inboxMessage": [
    {
      "messageId": "7732",
      "title": "inbox message title",
      "inboxMessage": "inbox message content",
      "cretDtim": "2019-03-18T13:39:12.000+0000",
      "readYn": "N",
      "messageUrl": "http://www.google.com",
      "messageType": "SERVICE"
    }
  ],
  "unreadCount": 1
}

Response Parameters

Name	Value/Range	Description
messageId	string	Unique identifier of the inbox message.
title	string	Subject of the inbox message.
credtDtim	string	Date and time that the message was created.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
readYn	string	Whether the end user read the message. Possible values Y,N
messageUrl	string	URL which may have more information about the message.
mesageType	string	Type of message. Possible values are SERVICE,MARKETING
code	integer	Resonse code
message	string

Retrieve Inbox Messages

Supply the message ID obtained in the previous request and retrieve its message detail.

Key	Value
Method	POST
Resource URL	{Inbox_URL}/v4/getInboxMessage
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Retrieve Inbox Message detail Request

{"messageId":"7732"}

Request Parameters

Name	Required	Description	Value/Range
messageId	yes	Unique identifier of the message. e.g. 5636	String

Retrieve inbox message detail Response

{
  "result": {
    "code": 0
  },
  "inboxMessage": {
    "messageId": "7732",
    "title": "inbox message title",
    "inboxMessage": "inbox message content",
    "cretDtim": "2019-03-18T13:39:12.000+0000",
    "readYn": "N",
    "messageUrl": "http://www.google.com",
    "messageType": "SERVICE"
  }
}

Response Parameters

Name	Value/Range	Description
messageId	string	Unique identifier of the inbox message.
title	string	Subject of the inbox message.
credtDtim	string	Date and time that the message was created.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
readYn	string	Whether the end user read the message. Possible values 'Y or 'N'
messageUrl	string	URL which may have more information about the message.
messageType	string	Type of message. Possible values are SERVICE, MARKETING
code	integer	Response code
message	string

Update Inbox Message Status to ‘READ’

Supply the list of inbox message IDs obtained in the previous request and update their status to “read” and their read date and time.

Key	Value
Method	POST
Resource URL	{Inbox_URL}/v4/updateInboxMessageStatus
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Update Message Status to ‘READ’ Request

{"messageIdList":["1000","7732"]}

Request Parameters

Name	Required	Description	Value/Range
messageIdList	yes	List of message IDs to be updated. e.g. [“1000”,“7732”]	String

Update Message Status to ‘READ’ Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Value/Range	Description
code	integer	Response code
message	string

Delete Inbox Messages

Supply the list of inbox message IDs obtained in the previous request and deletes the message.

Key	Value
Method	POST
Resource URL	{Inbox_URL}/v4/deleteInboxMessage/deleteInboxMessage
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Delete Inbox Messages Request

{"messageIdList":["94","7732"]}

Request Parameters

Name	Required	Description	Value/Range
messageIdList	yes	List of message IDs to be updated. e.g. [“1000”,“7732”]	String

Delete Inbox Messages Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Value/Range	Description
code	integer	Response code
message	string

Membership

Add Membership Card

End user can enter detail information of membership card in the wallet and manage it. With this feature, end user no need to carry the actual card but can use his/her digital card instead.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/addCard
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Add Membership Card Request

{
 "card":
 {
"merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
"cardName": "Delta Skymiles",
"cardNumber": "1234123412345678",
"cardType": "GIFT",
"balance": "10.00",
"description": "Gift card from delta",
"backgroundColor":"FF00FF",
"pin":"1234",
"barcodeType":"UPC_A",
"frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
"backImageBase64":"iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
}
}

Request Parameters

Parameter Name	Required	Description	Value/Range
cardName	yes	Name of the card	String
merchantId	no	Unique identifier of the merchant who issued the membership card. e.g. 418D20AC-A872-415B-ADB1-38EA90171898	String
cardNumber	yes	Number of the card e.g. 208738491092	String
Description	no	Description of the membership card.	String
cardType	yes	Type of the card. Possible values are LOYALTY and GIFT.	String
balance	no	Remaining balance in the card if available. e.g. 10.00	String
pin	no	PIN number of the card if available	String
frontImageBase64	no	Byte array of the front image of the card.	String
backImageBase64	no	Byte array of the back image of the card.	String
barcodeType	no	Redeemable barcode type. Possible values are: - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown	String
backgroundColor	no	HTML color code to be used in the background of the membership card. e.g. #FFFFFF	String

Add Membership Card Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Description	Value/Range
code	response code	integer
message		string

Get My Membership Cards

Retrieves all end user’s registered membership cards.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/getCards
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get my Membership Cards Request

{"imagesByUrl": true}

Request Parameters

Name	Required	Description	Value/Range
imagesByUrl	no	Define type of returned image. FALSE returns image as byte array. True returns image as URL. Default value is FALSE	Boolean

Get my Membership Cards Response

When imagesByUrl is false

{
  "result": {
    "code": 0
  },
  "cardInstances": [
    {
      "cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
      "cardName": "Delta Skymiles",
      "cardNumber": "1234",
      "cardType": "GIFT",
      "status": "ADDED",
      "createTime": "2019-03-07T16:38:10.000+0000",
      "updateTime": "2019-03-07T16:38:10.000+0000"
    },
    {
      "cardInstanceId": "0615edec-c19f-4466-8856-cbe8738e6bf2",
      "merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
      "cardName": "Delta Skymiles",
      "cardNumber": "1234123412345678",
      "description": "Gift card from delta",
      "cardType": "GIFT",
      "balance": "10.00",
      "pin": "1234",
      "status": "ADDED",
      "createTime": "2019-03-07T16:21:50.000+0000",
      "barcodeType": "UPC_A",
      "backgroundColor": "FF00FF",
      "updateTime": "2019-03-07T16:21:50.000+0000",
      "frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
      "backImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
    },
    {
      "cardInstanceId": "796fc94f-a9db-437a-90d9-7357002632d7",
      "merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
      "cardName": "CNAME CNMAE ",
      "cardNumber": "11111",
      "description": "test gift card",
      "cardType": "GIFT",
      "balance": "10.00",
      "status": "ADDED",
      "createTime": "2019-03-07T15:42:54.000+0000",
      "backgroundColor": "FF00FF",
      "updateTime": "2019-03-07T15:42:54.000+0000",
      "frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg==",
      "backImageBase64": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAADx0lEQVR42q2UbUxTVxjHz+3bbUsrFHzJBtuoVUvMwowvi1vc5uKWGRUSl6gZupm6TOc0waA1zkUNZtOYuemCJvvgpsYNsNSXkdItUxGKZSIgiE5eKopA6gdQIkp01Nu/z3NbMkGz+GEn+ec+93n5neeee84RYuRIzFwsRs92i/9lSFr9uA+9rc6NTQ8dyda3c18TWwqzhD/g0jWx2GafM0m8+nzA5Jk5+TUD8HYoWL/CpQyeWgSldS+i3R5VbLPv9rejI9+9JX5ONoqx/9Wd/GLO0Wv+MFDVA8z6vgXhzgtA/3mgLxAT2wONQK8PEf97qPlUE7KPEhlc/RTO/NKcTVkn78HXDZR2Aa7yQXzxdRHQdWC4un8CbpH/tg+PKuah7jPNDZssxo2EajM+OtS3oRYoug4cDAGfVwPOzdRNKP/Zur4T6NyDiNeBPe9KvzBjCKaZmCSmzlxThB2XgV/bgf3NQC59rXMrAa+sGq7LK/9VSx5QuwB3d5sUZjCLgfq8adLubbnZeL+wB9uJ8WU9MKfkPj5Zt1UtQO38uMiuyyJlx3RxIWkuIsVjwAxmMdBUslh/7k7JC9i2ZSnecRdi1kYv1rpXoevEJKBiPFBuj4ntKvJVTwaCU+g5gzQFUX8qmMEsBo4Krja2RU/b0Vdmx82Tr6CjJA1dxWmIniVI3YQYiKXadgyUvQwE0oG/HPTuANcyg1nq7guuNrQpf6TSrOmo3DUWK980wTVdjxUzjDjqTgEupKlim30c4xzOxbl0KL+nghnMYqDNs0RbHSlNpNlsOFVgxiVPAnorLWj3m+HbZ6C1M6ryFRhUXw/FOOfMPjNQaUPkt0QQI8gsBlryXpd+HPRQsCqBPksGGnRAowZoloAOUquI6YYU83GsjnJqKbciAYPFZjCDWepfnmgT2f37ZQVBK1DD3egJqqVigtyS6HBIeNBEoDDpKvkuUqyGcoKUG7Civ0BWmDH0l3mHp+6dqylVyiw0O+lvmjlEBWEtDn+lQ84kA5ZlGOD9Rqf60EyxK/wlFig+C7iWGU+eFgMd9NkNG3Td0Srqsp2gPUYEjhiwwyXjUqmMhmMy8j+WUX+c1jRMnYUsiFJ3XMO1zBh2lnlBxyeJRfVuXadyhoCtVjxso+cdE10Mxph6TfinhXwtVih/WsC5XBP/GU9fEKQxKSbxwQ/zNL67B+RHUVpw1FPHV+NqtCJangCOcQ7ncs2zYE9CeXNOdqaI5XlvSAc9y7Xnq926ayy22ccxzonnSs9z1Wrim9RByiRNjysz7kseughGjsda3MlcNDdCsQAAAABJRU5ErkJggg=="
    }
  ]
}

Get my Membership Cards Response

When imagesByUrl is true

{
  "result": {
    "code": 0
  },
  "cardInstances": [
    {
      "cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
      "cardName": "Delta Skymiles",
      "cardNumber": "1234",
      "cardType": "GIFT",
      "status": "ADDED",
      "createTime": "2019-03-07T16:38:10.000+0000",
      "updateTime": "2019-03-07T16:38:10.000+0000"
    },
    {
      "cardInstanceId": "0615edec-c19f-4466-8856-cbe8738e6bf2",
      "merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
      "cardName": "Delta Skymiles",
      "cardNumber": "1234123412345678",
      "description": "Gift card from delta",
      "cardType": "GIFT",
      "balance": "10.00",
      "pin": "1234",
      "status": "ADDED",
      "createTime": "2019-03-07T16:21:50.000+0000",
      "barcodeType": "UPC_A",
      "backgroundColor": "FF00FF",
      "updateTime": "2019-03-07T16:21:50.000+0000",
      "frontImageUrl": "http://api-dev.fintiv.co:8080/image/membership/0615edec-c19f-4466-8856-cbe8738e6bf2_front.png",
      "backImageUrl": "http://api-dev.fintiv.co:8080/image/membership/0615edec-c19f-4466-8856-cbe8738e6bf2_back.png"
    },
    {
      "cardInstanceId": "796fc94f-a9db-437a-90d9-7357002632d7",
      "merchantId": "418D20AC-A872-415B-ADB1-38EA90171898",
      "cardName": "CNAME CNMAE ",
      "cardNumber": "11111",
      "description": "test gift card",
      "cardType": "GIFT",
      "balance": "10.00",
      "status": "ADDED",
      "createTime": "2019-03-07T15:42:54.000+0000",
      "backgroundColor": "FF00FF",
      "updateTime": "2019-03-07T15:42:54.000+0000",
      "frontImageUrl": "http://api-dev.fintiv.co:8080/image/membership/796fc94f-a9db-437a-90d9-7357002632d7_front.png",
      "backImageUrl": "http://api-dev.fintiv.co:8080/image/membership/796fc94f-a9db-437a-90d9-7357002632d7_back.png"
    }
  ]
}

Response Parameters

Name	Value/Range	Description
cardInstanceId	string	Unique identifier of the membership card instance.
cardName	string	Name of the card.
cardNumber	string	Number of the card.
cardType	string	Type of the card. Possible values are LOYALTY and GIFT.
status	string	Status of membership card. Possible values are ADDED and REMOVED.
createTime	string	Date and time when the membership card created.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
updateTime	string	Date and time when the membership card updated.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
description	string	Description of the membership card.
balance	string	Remaining balance in the card if available
pin	string	PIN number of the card if available.
backgroundColor	string	HTML color code to be used in the background of the membership card.
frontImageUrl	string	URL to retrieve front image of the membership card
backImageUrl	string	URL to retrieve back image of the membership card
code	Integer	Response code
message	string

Get Merchants

Retrieve list of merchants which provides membership service. Returns detail of merchant and sorted by the name of merchants.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/getMerchants
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameters

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Merchants Request

Retrieve merchants who provides membership service Request

{}

Request Parameters

Name	Required	Description	Value/Range

None.

Get Merchants Response

{
  "result": {
    "code": 0
  },
  "merchants": [
    {
      "merchantId": "3D4F43E3-5B0A-462E-8A1D-305ED8EE045D",
      "walletId": "JANUS",
      "serviceId": 10518,
      "merchantName": "Hilton Honors",
      "customerCareInfo": "Best price. Price match guarantee.\nFin a lower rate",
      "updateDtim": "2019-03-13T14:03:16.000+0000",
      "phoneNumber": "000-000-0001",
      "serviceHours": "24 hours",
      "websiteUrl": "https://www3.hilton.com/en/index.html?msclkid=b8af23ae9a551a6d231e7f27970c3f07",
      "barcodeType": "QR_CODE",
      "nfcService": "N",
      "showInCatalog": "N",
      "merchantBackgroundImageUrl": "http://api-dev.fintiv.co:8080/image/membership/3D4F43E3-5B0A-462E-8A1D-305ED8EE045D_bg_xhdpi.png",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/membership/3D4F43E3-5B0A-462E-8A1D-305ED8EE045D_icon_xhdpi.png"
    },
    {
      "merchantId": "1CD1179F-D64B-43E3-B066-19CF773BBABF",
      "walletId": "JANUS",
      "serviceId": 10518,
      "merchantName": "Marriott membership",
      "updateDtim": "2018-11-30T21:31:53.000+0000",
      "barcodeType": "QR_CODE",
      "nfcService": "N",
      "showInCatalog": "N",
      "merchantBackgroundImageUrl": "http://api-dev.fintiv.co:8080/image/membership/1CD1179F-D64B-43E3-B066-19CF773BBABF_bg_xhdpi.png",
      "merchantImageUrl": "http://api-dev.fintiv.co:8080/image/membership/1CD1179F-D64B-43E3-B066-19CF773BBABF_icon_xhdpi.png"
    }
  ]
}

Response Parameters

Name	Value/Range	Description
merchantId	string	Unique identifier of the merchant who issued the membership card.
walletId	string	Your tenant ID who manages the membership merchant.
serviceId	string	Unique identifier of your subscribing membership card service
merchantName	string	Name of merchant
customerCareInfo	string	Long description of the merchant.
updateDtim	string	Last time the merchant is updated.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
phoneNumber	string	Contact number of the merchant
serviceHours	string	Merchant service hours.
websiteUr	string	URL of merchant website
barcodeType	string	Redeemable barcode type.
nfcService	string	whether the service is NFC enabled or not. Possible values 'Y' or 'N'
showInCatalog	string
merchantBackgroundImageUrl	string	URL to retrieve merchant background image
merchantImageUrl	string	URL to retrieve merchant logo
code	integer	Response code
message	string

Report Card Event

Client reports membership card events to log their history in the server.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/reportCardEvent
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameters

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Report Card Event Request

{"cardInstanceId":"0615edec-c19f-4466-8856-cbe8738e6bf2",
 "eventTime":"2019-02-08T14:23:35.443-0500"}

Request Parameters

Name	Required	Description	Value/Range
cardInstanceId	yes	Unique identifier of the membership card instance.	String
eventTime	no	Date and time the event occurred. If not provided, current system date and time is updated. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	Date

Report Card Event Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	Response code	integer
message		string

Update Membership Card

Supply the membership card instance ID with information to be updated and then update the membership card. Only provided information is updated.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/updateCard
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameters

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Update Membership Card Request

{"card":
{"cardInstanceId": "852c8e1d-cd6c-4ecf-8c2b-deb64be16561",
 "cardName": "Custom Card",
 "cardNumber":"11111",
 "cardType":"LOYALTY",
 "balance":"20.00",
 "description":"Popular card",
 "frontImageBase64": "iVBORw0KGgoAAAANSUhEUgAAALQAAAArCAYAAADR/aKkAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAABowSURBVHja7F0HeBXVtp7T0gtNQ4siLUBCkI4QadKkiSYIN7RLE1B4iqCiIAgIgiIgIBIf5YJiEJQPlHIRBKWGGojB0DsEFKmBQJJz5v173t7nrrOz5yRR0athvm9/J8zsWbPLv9b619p7BovmeVi0/B26dv/4qxyWwjSXFsWvxWQgdFLug/qvB2aLFyDrf0dAs2IlhYLbRYrOf++D2jtoLPkAj/4Hza1srFSG6W8xl3YFmO282Ph5AeAcFCf/tdwHcy6g0HG0KADtkn71P2AcVW2UrfTfai7tpMMCzD682Pk5nYM4CyVbQT0KK5hlQ2AjxSqBx8WNAS3C4/0RoJYVzaWYR0sB5er55Ol6AXh9fuuaejkKaDYRDhRfFD8OahvvfDYfEE2iHnohBrPs0Ry8UO8mBtwpGQUL/7f+B4DZKrXXQgzVrzFOMl1RURrNS7zlzVvoJnU1SfFVdXUzC80AHZCYmNgkIiIi0mq16j4+Pjm6rl+OjIycyycix5CgFy48W3CQsRIGwEcqDsm7CTBn83soBXH9/zDq96KtMqiN+b158+ZYXNODgoJGK6xcfiytrjBoKqpFQecy8RaaCS3TFVROU4xdrlhO5tCCcviVL18++tFHHx0kKmIgtuNnIbcy1sIGaCi2PE5C+f25R/Pj/3aQcaV07S4X5SQUxMoBrd9DC+0BOLvdXpMZKcmYaV6srGYCUJd0XU4m6BJIVR7DovAULgnQ3uibRkBttNEuNUi4Tp+srCw7HWen02kllsd4GJ9kWsd0Ymw2W745mjc5BZH1W9ujuJ8CmgE4gBSDps2YMaNeixYtmoSFhVUqUqRIJXHj1atXd964ceOHs2fPbmzSpMk6QuHulWFQZa5s/v7+nfl1B7lOMWDJJ5idkjWV4wedeChdAVKrwpq7JGuuUhIX8XiCurlUlIO6Unt2drbN5foP+HNyciyEJ+YoGqtzkOh5BFHe+JbOweb+G+0wfh0Oh1mu3FQWlZOP9uRyrdL9YnwEzWCWOZCXgG7dupWbNGnSSyVLlqzpNiVk/EJDQ+uzEh4e3g//LEGfK+pJffQaNIlxKQCPFhTJpjivArQMapdUnARIbtwo4occYk3pM2xSWliTAG2VAm4LeW6WYr4N7FlNUk82ZpHZQIsCQFtJwEhdrK+UFbEqsgA2Yv2Fm5YLlePWdDbJfKJlWT5Se/xJm3ykAM2qaI8Apny/H7nfJg2s6IOozyxz4CuvvBKdkJDw4YMPPliTjplZkbmfoo+U1tA0qhsErH4ez9BUFvrMmTOjWCH9d1y+fHnxvHnzan777bcdQS033b179xj73bhxYwf2bFyrcfHixdk4fxrl7M8///xx3759S9BgeOrUqRV++eWXRFw/iXLi9u3b+9PT0z8aN25cJQkrjq5du5Y4d+7cpMzMzP2sPu77bMGCBbVOnjw5av/+/f8k9Y35SElJeR7ejbXrONq15dixY/8jzY9FznJosgZhUCzUFeLfVj6JOrFUOVKOOlvSXIvJ5MiWwUWCJycJPJ0KC6maaDkDI7eHWggbUQq7wk26FG1wyTGGoBoAc/XRo0e/A24aRMfrzp075wEURjPOwNK7ypQpUz8gICAKNC1UGiMV+GwKS+eSeGN+qHcuw4I2RJO5N84hQGz49NNPj0cfQlJTU+eBFp2LiYnp3LBhw+kAuaVu3bovQwk+37Vr1+elS5cOr1at2vDJkycnAOjxAg8lSpQoBgDvOHTo0Hxm/OCJyiIGGzps2LAVe/bsafnVV19dE22fM2fOJz4+PuEHDx6ccuHChbOI16JiY2NnsHO3bt2awsfYGIu0tLShDz30UBzkLjh69GhqZGRklUqVKo04deqUs1y5cu/LHtpuNhKMYlCXCRdn5ZMoQJEtAUdE8VlkwiyKbIBDsuYU0EJOFvnbKXF8OaNgM5EjgtcsknGwSik26hE0ErSJQE60Q/SFegXDs7z44osvAbBBdKxgZT4EGObyQDCbjFX2kSNH2hIlUymrTRojTbGgZRT6TC9g9nDf8LzyOWOeoWgh8fHxnVetWnWDX99+7dq1dY899ti0Tz75JHbAgAGpor07d+60VK9efdzChQsf7dWrFztv7dmz5yH8HiXt3gure6lLly6z33rrra4ANBsP7cCBA30A3KjFixc/079//1T+rB2zZs3a1adPn6WI3dzUZcqUKZEPP/xwn2XLlg3Cc3byMdgG5SoDBRqMv6fK9NNqNhhM+xWUg01iEEowSohUgjjgaaRvV1CNAM47VTKoHOr6HQRM/tL9obyE8HOB0v0+0v1+5H7ahlDydzBvR6BEhzxozpIlSzoi8KtAxwlu+j2AeT5RCFqyK1eu/IUUe6jSpnScAkgbPNwsrK0lD8qhyXSLz6uFymH1YfGWAszXqcLAy5yFh9lOwczqA1Dn2D2w7MVM0pZG6d27dzKrR0FaqlSpNqAY/waYD1JFGzx4cBrBmYGZZs2atcHzDwHM+4hXte7bt28tm69NmzbVMFspVEX4FhRqsQ1Aw42E4OHRcANhLJ8JrnRj5cqVSfPnzz9O3OQdEjjSBRsDDGPGjImuWLFieFhYWFkhn8lJTk4+OHbs2BReX0yEWJ1058j5RBuAhcuv1qJFi1qsLcy1w206T5w4kfLll18mY4IuEQtnkRTLnWZ7//3360ZFRUUwGazAvf04ZMiQrbiWyZ+bRTID7hiicePGcXSM4BLXtG/f/msvAZ3LS8rLToJNAWCxsJUlrdo6yTwVKPPB6nOqoksyXBI1M86z8ZDOGwrArgGobkA+8cQTRWfOnMmC4haYhxDg5Sa49m5WjyuYYUl9fX0jwZ/XKoJy5j1E8sE4X7x48Qh/f/8q169f36nApxYSEhIqL7aYAdoiazoD+PLly2PBrTohIAmilTGx2htvvLEHgcG42bNnH+anBfVwLwmDM41F4NQKoAtWPbRJkyYarEH65s2bZyJwWEkoiwC08BCB4HANu3fv/hKsVElZTnR0tNapUycNQUQqOOBr3bp1O8DlUOvnt3bt2u61a9fuIvenTp06Gp5/E+1d1LRp0wT+bKpUvlC8uhjsMDpGEydO/JIosFNaSdOl/LOLXLNJysYU1vf48eOzihUrVlfI/+mnn96OiIh4j7Y1D9qRK+XG69PFDkMGgCtWhOnijKiTQ5WPgZzf41aKRYsWzQFYy+7du3cGrP0Fdg7eqBqMVnOaXya40uVsDjnvbiuCwLT169dP58bKxRb5AgMDs4ODg7O2bt26TzYOphZaUA5xwFVEsWI2iEWLFq0Dy7sYlnvAiBEjditWezRob2xek4BBKdWyZcuJ4KF14Q1Gksl3CDAiqGjduXPnkXnJAlCj0PGiUqotoFatWmFz584dBn4WYyYDnDIYPPEFeI0yNWvWHEeU06Af9evXr0nvg1dIgsJf5s+hgXO2tNgiW2uLAtD+GMPqoDN16TNgMD6lkwfX7Y1HK3PHJJLMUQA6R8KArgC0jdWlioF2Rfr5+VWDIRqO4HIDsbpJaONgKhux2A1QlXAV12cy+TMNY4C615mxAXXZRoJ9sUglaJxHataMQ2vCrajK1atXj1y6dGkfOFYGPY+GByM4SGjVqtUDJOByTyKtm5GRgaA4Pfn8+fMHwJMuyc9ANP00LGi8lBo0OGyHDh1eNGubXGClrQQsBl354IMPBpYtWzaG1mNtgCtMyczMvEXPlylTptO6dev6E5pitAPKUIPWA904zZ6DAKjeihUren399dd9V69e/RwCm+aNGjUqQ/i9HxkbWnxo+rBjx46dqHxY5yUJCQlX6QR667dCcYzAUucHCVaz+dy5SGbHKMAAUxhdOp/NrCS7B1bTCG7hdYPYvxFEXicBbw4Mkz+X7c4agYashaK2efLJJ4to0oYuTocEoLMvX778AwxctU8//bSetKnLbPeiKaCNTsuBBlzg1+CsceC/PapVqzYYk91x27ZtC2gdZtlee+21f5AAxp1+Onny5HyA4w0MwOMARA/w1pGgB2898sgjL7777ruTAL5bVFalSpXi5Mn/8MMPm4msAivsHnR4CmQ+idIEpR4i6ud++OGH0VCWBAzgDbrpCl6kAeS2lgK5xWjD4Bo1akwA0PshEt9Ir0dGRnaXlMoOj/QIrVOlSpXIixcvfjFw4MDxDRo06F23bt2+oDP9QYumgs+vT0pKGgf6UpoEzj50ZZYEnL7PPPNMufLly7el8tHHBNmqoa/uYhIU6tJScTYBuBvQrD4HZzYtCvAboATIGNg1BmxmJdHHzeC+19G/l4YPH84oYBYUujm8YAKRzaxpzvfff5/IAjpGTxGLPcTwMWHChKjDhw/PkahP1qRJkz5jee/mzZtPg/WPe/bZZxk1dD3//PMh8JxPqRbNrHlRDlFgIfY99thjby9cuPAILt9icRwL/uBiEtPS0tZJQPynlKIzIly46Zk9evTYpNjIYoElS4Nl+4LKAT+uIifPoUQlaZ0tW7asfPnll7fTFbZ+/folIUhZCqowBZ1Poxbwqaee6kzvT0lJ2Qi+vIJqOSzLfFjsn6iSguY8IfrRtm3bUjKAQKeivC10gIp1ROCcCJ5d2ySD414U6t+/fztp7Ndj0s8qlpithM5ZJEDL1lkG6V1RvAFaBj8DGmKHbJ7lyOIJgNt79uwZCHpQFnOx/sKFC4cZTYNB+YQBHdzXnQbFfCSDZw/B3FZD3LUGdfeDUnyG3x18rJ28XXegFBcB5P5gAikwohOmT59+APXOjRo16giUeLoqn2/3ZqFpBM0MNo/6b3MhIt/oA237AsFgaxJMBMOSxrzwwgvfc62muWiHYvXOKEOGDNmCYK4XbQgi5/o846BzDuii7UJHq8Nb/PvHH3+8q+Xel0z5qaN9+/bhDzzwQDS9H5Zvo2TNDM6empq6E1a2g6gHC14ZP1uYTHDrsAJmFwSnLw0D8BYm8mmSebESi+0Lj1UE1r4NlQ8v+AUxQKI/dKOTS1C6PHawaeXKlWsnVwK9C1RZO3jRtqqEAYL39Ty96d48BIrEzlX45ptvmrJKoJ3fcZlzibEx8NauXbtV+FkHr1wD9KPI0qVLD27YsOHa2bNnX+KAdq9lIKBn8VgnKEoRGKNotrEK3PoKrPZuRbbIPCgUHFoCdBZ5mFMEPdCk89OmTctgq2VkMFgAuYOAy73Pet68eR0ArNJsAw/kspy3FZ05jXJFnhSyVGxcAK86TetAU6svW7bsvWPHjm3dt2/fnrFjx+4gAamLpOscMTExlWX5GJgoWOSqIqJn7WH3YJIfpnXR3koUHLIcUJtkuM1vwfuTFi9efJ49Dwod3aVLl3/AOjcS9VgaCp4oHoq7UAK0kUIcOXJkO7QlSMhHvLJ70KBBO/kY+pCsiIVs0tFNAK1pni8R6PnYHlqQ1cdcBUBeLwWlmrQJShgZ16uvvpoizg8bNqw04fLZkrKygPhnlA2K3X56frMcHhE0/5u+cWGleVVM6HEAtIaUt6ab3n0BemCnZV9Vqg33RrF0mRy180DbHRDAHa8CP+4eGBhYhYAkDFYzlpVevXpp4LLfwVWtGDFixA6SP2ZJ/ZKy/MaNG3f1ptSSQgtvkyu7AGs+lFMxkfpywksdRJm0ffv2CaAEYsmZ0Q/mzRLJ5LoBDb7+JJUNOreR1KGZExt3ze5JhfVl2RadZ1108HBV1uNebE0127RPqa0uYcZjGR/WtxXrN+jIcsLXXYr0nmpbqibvtstzYYUvmdolV+7mcrJFJ4A2aAk4cgu4/DcKuhhAo17RSbiocbGxsaMpqOkBa9oU15uCjiTExcV9Ktopt7EgB29HFk9bORVy6JK5sEiGEsJzbG/durUb0MHBwfXI2Lhz2x999FEHBFwlhezMzMz0+Pj41YSS0NSVXbGf2AkQW44eParzhR4d8Yz8pse92G+t5QPMBng///zzqPDw8OanT58+yLwh5jCUURv8toc3mgFvdEyxJ0hTbGtVKmi+89Ac0CJb4CKBlkPsEVBYdPfOOARpfWWrdu7cua0IHI4D/DY/P79QWNDycPWRJvlUt7aOHz9+P0o38Ot2mLAGGKDGlO6IAxZ7ACjIkTFjxiSrvA642K0rV64cBy9zsSJWCuXC6l67du1HbhFtiL53IZDxeNa4cePqjh49+jtFoK2fPHnykiJfLIyBOyBs0KBBHK2XlJS0VIzxm2++Wad79+6TqYCIiIiKKheMMdFAf4x2i997dOhSeyzimeJvGXgZGRm/QKFjatWqNZJs5FoJHPRu2rTpF8Qw5PWan/K8181JqqVvIsxOonVbiRIlPIItdCpNaNY777zTFJbHI5B67733Xl6wYMERaUnaF8HdvxRuX35jwZhEBIuMU7EMxxxMdtU2bdqwgepA769fvz4LUvaKQZK8DqMcY3mwe0facOWU/q2RgNaBibkIquOmThUqVKjK22Ihde1ePIOVbniCgjajY4Txznjuuec28DG23L59218hI0Cxy9HlhU/f0wNz586Ps78RrMsLSZa+ffsyC9xRy/1mi1ORa9a5nHy3wWqyquTOcogCa2bRPN/SEAsNjp49e1aUE/toyBkBIvDHMHotPT09BWA+rniuU5aj2NtrU+y7ZtmKEwB14urVq+fS+8HXS/EJv7tt27bd9BqscmCPHj3Ke9l3IW8nFbv47qIPe6WFoDqKDUWGsletWrWCtIhzSM5aNGzYsBWts2PHjpV0qyqsmK9i8SRAsR/dkteiyx9VFBRB3pqbLeW4PcCMWKnAimlVTKRbS2heE9aoVFRUVHFpU76xbxWR/DO0LtzzzsTExBNih5lYKhUF9CBQ1dGuXbuGKxYIdGny5RU2DysAsNxUbKY38prz5s07AEuXTq8jiOyueEPCKo2NLm1LvbNz585vqZxixYrVnDBhQkuyV4T9OuB62RJ6S1oXAXQSpVDDhw9/lHk4ulgED7aJLghlZWX5KsbGV7ULj+7F+TOLCW10SmDOkbyim2Yo5OR52E20J5vlA6kwFqwgYn938uTJb69ZsyadDRosT+jbb7/dG9apEa2LSPVjslONpdrO0OshISEVpk2b1nro0KFrBI2YOnVq88cff7yn3AGyQcYA9Mcff9wuNDS03MGDB08sX778VGpqKgOrpXLlygFw0Q2bNGnSncrAs7fx3Dm7P+fIkSMroZgDxfXixYvXWL9+/cQlS5bMBeDTpGjdBV4XCIWtzFbH+vTps5Xw+M3NmjXbW7Ro0dpCVqtWrYawdCT6su7QoUMZsP4V+/Xr9zziA49NTCtWrFii/eedOCess8f4AfAnMTZPsKCJvVgBK2VDO8PksYGX6wEPlMlKhw4dplAlLCgQ7sWRnJys16xZk9IKOYhUfl+D3fdr+2AhCW+6NTN40aJFA8FdBqluunnz5lFYjAwAq5IcjMFCrm3evPkgriDMavjXq1evJAK4lTabLTi/csSxZcuWPpjczYK3L126dBAi+Zfy20H0o+mMGTNO8X4am382b96cyFch5bghA206LIJBBC8RbOM73+k2sW3btjMJ7w1Au2rDq8yW++XtuHjx4v+2b99+MgkIg/bs2ZP0W8FTp06dB7niGlYPMv98RP9OB0vn/loLLVxqpsPhyKIacuzYsc8qVqzINgtpgYGBlVByWQKAM3XWrFnD+cCKvdCuXbt2pYMPzYiOjh5JHy7LuXXr1mGA6gYA7t4yCetGP85i1fJ+U8N9nDlz5nWA+TBZlTPc2+uvv94X9GAuQF1V2mEXhGfXVuWiWRaE5JgNugAvsxtgHhAbG5uQH1BfvXp1CcA8nq5IiqDxdzhcsrsujIdVwRGNtXkfH5+75G2VG/Hx8e8iUHmVvSsncyV2/fz585NjYmJaggakC87KC6MeGXC9/9q9e/cwVlfFt44ePfrBqFGj+ly5cmULPQ9Xn033HSA4/SUv7oY2psJtxcfFxc0jGYw7XNFuITg8DyrRie3PVvVH0b/TmZmZJyiH5rIypkyZsgs0KI5tQje7n22wOXXq1OutW7ceyu/LJNsIMn4nvuqRt/1v4ND3gIsXaBmTvjwqf9bK46ukc+bMaYsgqCzPK55atWrVJr4XmL6DJ7/D596pxngwePRDbF0ek3194cKFazZs2HBVWkWi+Ui6F8DIy4KnNgZ3j+avExkWFHThdFpaWjKuHZeW6V2a52cIPN4phCJFs6XuIkWKhPOPsBhvv4BmHGB58okTJx4lAYyumbwr2b9//3LgwzEIoBlN0ZkscPbNkL9X7DYjgY/VZKxthAKyDAejYkEwCPV69+79Op28Ro0a1WcpcpTrXDnuiv5Caf82XwFCPwsMaBrl2xTpMdXnCeT8ofymNp14+oa1Xcv9ySh5bV71qpKsdHQDkk6AmyMV+Us8qre+zT6Q4pRkORWyHFrub1JYvIyN/N0JldGgm/2Ndx8HDBjA3tAZQycPQfSjHNAZhD8b/UXs8bcBNPpZIA5NP6lKJz9H2lDi7aMu9Es6Mgjp125sJkoh58LNPtznlPLRZl/ecWrmX9ik2Ry6jG/WL5U8WRZVCKsil+2x0YYslVvJOFsJ0O1k05GhcKBedxTu9y7xirkoR2E87Irkt9kavdevDNHJ/u6774xf8FQV6L3J0PLYc5DXF4+U/8uAl/bkaPn7GqZZGymozWRomvlXPs3G26F5fpHIhiD9ruI7HHR100X7W9g+pKla+jYF1MaNG9k2yzy/BYd6HtZB/JvJK8j9Zkd+ZKhk/dr25KNtQo7+a+/30kcLt8AGv/bz81NZaA8wy+Nf2AFtng/CACFo0/NTz+z4rffnV8a9kOVNXn7lFBBk1KMZLy4g0FQBOosCujADuUCALqzu6088aBrVwufg4p07d7aK63wXIM3i3J8nreD/DcH9449bH6AZD9U3/HIU2ZNCj2j7fez811poF+HJLi13WtF1H8j3LfRfbV4sBcjC3Af1fUD/peamUPzHmb/1+D8BBgDOFJzndzJ3qQAAAABJRU5ErkJggg==" }}’

Request Parameters

Parameter Name	Required	Description	Value/Range
cardInstanceId	yes	Unique identifier of the membership card instance. e.g. 418D20AC-A872-415B-ADB1-38EA90171898	String
merchantId	no	Unique identifier of the merchant who issued the membership card. e.g. 418D20AC-A872-415B-ADB1-38EA90171898	String
cardName	no	Name of the card.	String
cardNumber	no	Number of the card e.g. 208738491092	String
description	no	Description of the membership card.	String
cardType	no	Type of the card. Possible values are LOYALTY and GIFT.	String
balance	no	Remaining balance in the card if available. e.g. 10.00	String
frontImageBase64	no	Base 64 code of the front image of the card.	Byte
backImageBase64	no	Base 64 code of the back image of the card.	Byte
barcodeType	no	Redeemable barcode type. Possible values are: - UPC_A: 1D Product, UPC-A - UPC_E: 1D Product, UPC-3 - EAN_8: 1D Product, EAN_8 - EAN_13: 1D Product, EAN-13 - UPC_EAN_EXTENSION: 1D Product, UPC EAN Extension - CODE_39: 1D Industrial, Code-39 - CODE_93: 1D Industrial, Code-93 - CODE_128: 1D Industrial, Code-128 - CODABAR: 1D Industrial, Code-128 - ITF: 1D Industrial, ITF - RSS_14: 1D Industrial, RSS-14 - RSS_EXPANDED: 1D Industrial, RSS-Expanded - QR_CODE: 2D, QR Code - DATA_MATRIX: 2D, Data Matrix - AZTEC: 2D, Aztec - PDF_417: 2D, PDF-417 - MAXICODE: 2D, MaxiCode - QRCODE: Deprecated. QR Code for backward compatibility - None: No barcode selected. - UNKNOWN: Unknown	String
backgroundColor	no	HTML color code. e.g. #FFFFFF	String

Update Membership Card Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	response code	integer
message		string

Remove Membership Card

Supply the membership card instance ID with information to be updated and then update the membership card. Only provided information is updated.

Key	Value
Method	POST
Resource URL	{Mem_URL}/v4/removeCard
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Remove Membership Card Request

{"cardInstanceId":"852c8e1d-cd6c-4ecf-8c2b-deb64be16561"}

Request Parameters

Name	Required	Description	Value/Range
cardInstanceId	yes	Unique identifier of the membership card instance.	String

Remove Membership Card Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Description	Value/Range
code	Response code	integer
message		string

Store Locater

Get Store

Retrieve list of stores in the search conditions.

Key	Value
Resource URL	{Store_URL}/v4/getStore
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Stores Request

{
               "accessibility": "Y",
               "driveThru": "Y",
               "fullService": "N",
               "latitude": 34.04457909523886,
               "longitude": -84.48085648015558,
               "merchantIds": ["B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A"],
               "mobilePay": "N",
                "radius": 21,
                "specialVenue": "N",
                "wifi": "Y"
}

Request Parameters

Parameter Name	Required	Description	Value/Range
latitude	yes	Latitude to find coupons in the range. example: 34.044454912173904	Double
longitude	yes	Longitude to find coupons in the range. example: -84.48063315578163	Double
wifi	no	Whether the store provides WIFI. Possible values are: - True: WIFI provided - False: WIFI not provided.	String
driveThru	no	Whether the store provides driveThru. Possible values are: - Y: DriveThru provided - N: DriveThru not provided.	String
mobilePay	no	Whether the store provides mobilePay service. Possible values are: - Y: MobilePay service provided - N: MobilePay service not provided.	String
accessibility	no	Whether the store provides accessibility. Possible values are - Y: Accessibility provided - N: Accessibility not provided.	String
fullService	no	Whether the store provides full service. Possible values are: - Y: Full service provided - N: Full service not provided.	String
specialVenue	no	Whether the store provides special venue. Possible values are: - Y: Special venue provided - N: Special venue not provided.	String
allDay	no	Whether the store opens all day: - Y: The store opens all day - N: The store doesn’t open all day	String
radius	no	radius from latitude and longitude to find data in the range. Unit is km. e.g. : 1000000	Double
merchantIds	no	Identifier of the merchant associated with the location.	String

Get Stores Response

{
  "result": {
    "code": 0
  },
  "storeList": [
    {
      "storeId": "E0A3E9E5-7FE9-44FA-B9E5-6F7E59177CEF",
      "serviceId": 0,
      "storeName": "Burger King Duluth 2",
      "street1": "2111 Pleasant Hill Rd",
      "street2": "suite 100",
      "city": "Duluth",
      "state": "GA",
      "zip": "30096",
      "country": "US",
      "latitude": 33.957483,
      "longitude": -84.134155,
      "phoneNumber": "778-770-7000",
      "monday": "0920-1120",
      "tuesday": "0920-1120",
      "wednesday": "0920-1120",
      "thursday": "0920-21_2",
      "friday": "0920-1120",
      "saturday": "0920-1120",
      "sunday": "0920-1120",
      "wifi": "Y",
      "driveThru": "Y",
      "mobilePay": "Y",
      "accessibility": "Y",
      "fullService": "Y",
      "specialVenue": "Y",
      "cretDtim": "2019-02-04T09:46:13.000+0000",
      "merchantId": "B94F3EE2-EEB1-4EBD-82D2-AB422FDA465A",
      "distance": 20.752155066456638
    }
  ]
}

Response Parameters

Name	Type	Description
code	Integer	Response code
message	String
storeId	String	Unique identifier of the store.
serviceId	Integer	Unique identifier for the Store service.
storeName	String	Name of the store.
street1	String	Street address of the store.
street2	String	Street address of the store.
city	String	City of the store postal address
state	String	State of the store address
zip	String	Zipcode of the store address.
country	String	Country of the store address.
latitude	number	Latitude of the store
longitude	number	Longitude of the store
phoneNumber	String	Contact number of the store
wifi	String	Whether the store provides WIFI.
driveThru	String	Whether the store provides driveThru.
mobilePay	String	Whether the store provides mobilePay service.
accessibility	String	Whether the store provides accessibility.
fullService	String	Whether the store provides full service.
specialVenue	String	Whether the store provides special venue.
cretDtim	String	Store registered date/time
merchantId	String	Identifier of the merchant associated with the location.
distance	number	radius from latitude and longitude to find data in the range.

Skin

Get my Skin Service

Client retrieves list of skins configured in the backend. Only active skins are returned. If any skin cached in the client is not returned, client should delete and not use it.

Key	Value
Resource URL	{Skin_URL}/v4/getMySkinService
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get my Skin Service Request

Retrieve list of skins to be monitored

{"bundleId":"com.corfire.white.wallet","walletId":"JANUS"}

Request Parameters

Parameter Name	Required	Description	Value/Range
walletId	yes	Your tenant name e.g. JANUS	String
bundleId	no	Identifier to detect default skin for the client. It could be bundleId in IOS, package name in Android, or any unique value predefined in the portal. e.g. com.corfire.white.wallet	String

Get my Skin Service Response

{
  "result": {
    "code": 0
  },
  "skinList": [
    {
      "skinId": "2B62F622-C2C1-441B-B746-FB1136C9F261",
      "skinType": "DEFAULT",
      "lastModifiedDtim": "2018-11-14T01:07:38+0000"
    },
    {
      "skinId": "F6EF56A4-418C-4451-AC66-6D155A772EA1",
      "skinType": "BEACON",
      "lastModifiedDtim": "2018-11-14T02:26:42+0000",
      "beaconIds": [
        "32523534634634636"
      ]
    },
    {
      "skinId": "00D3E1B8-177B-451B-8D53-5DB584422A56",
      "skinType": "BEACON",
      "lastModifiedDtim": "2018-11-14T02:30:24+0000",
      "beaconIds": [
        "123456789087483829"
      ]
    }
  ]
}

Response Parameters

Parameter Name	Value/Range	Description
skinId	string	Unique identifier of the skin.
skinType	string	Type of the skin. Possible values are DEFAULT,BEACON,GEOFENCING
lastModifiedDtim	string(date-time)	Date and time of the skin data last updated.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
beaconIds	string	List of beacon IDs when skinType is BEACON

Get Skin Service

Wallet

Backup Client

If your application has any customized data to be stored and managed in the server, provide them using this API.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/backupClient/backupClient
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Backup Client Request

{"data":"{contactlessStatus:false,isOptIn:false,mayAskActivate:true,mayAskIF:false}", "elementList":[{"elementName":"FAVORITE_CATEGORY","elementValue":"100,200,300"}]}

Request Parameters

Name	Required	Description	Value/Range
data	no	Plain string data(i.e. JSON string) to store in the server. e.g. {“contactlessStatus”:false,"isOptIn ":false,"mayAskActivate ":true,“mayAskIF”:false}.	String
elementList	no	Key/value backup data	List Element
elementName	yes	Key of element	String
elementValue	yes	Value of element	String

Backup Client Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Response code
message	String

Check Configuration Update

Supply end user’s last configuration check time to determine if configuration update is needed.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/checkconfigUpdate
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Check Configuration Update Request

{"appVersion":"1.0","buildNumber":"9.0.2","categoryDate":"2019-03-20T17:21:19.181-0000","faqDate":"2019-03-20T17:21:19.181-0000"}

Request Parameters

Parameter Name	Required	Description	Value/Range
categoryDate	no	Last date and time that the client updated category data. If no value is set, categoryUpdateYn returns Y. Format is yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	String
faqDate	no	Last date and time that the client updated category data. If no value is set, tncUpdateYn returns Y. Format is: yyyy-MM-dd’T’HH:mm:ss.SZ e.g. “2019-02-08T14:23:35.443-0500” yyyy: Year, e.g. 1996 MM: Month in year, e.g. 07 dd: day in month, e.g. 10 HH:hour in day(0-23), e.g.0 mm:Minute in hour, e.g. 30 ss: Second in minute, e.g. 50 S: Millisecond in the minute, e.g. 443 Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800	String
appVersion	no	Wallet client version	String
buildNumber	no	OS build number of mobile device.	String

Check Configuration Update Response

If no update available

{
  "result": {
    "code": 0
  },
  "tncUpdateYn": "N",
  "categoryUpdateYn": "N",
  "faqUpdateYn": "N",
  "tncUpdatedServices": []
}

Check Configuration Update Response

If update available

{
  "result": {
    "code": 0
  },
  "tncUpdateYn": "Y",
  "categoryUpdateYn": "N",
  "faqUpdateYn": "Y",
  "tncUpdatedServices": [],
  "TnC": "Default TnC.\nThese Terms of Use constitute a legally binding agreement made between you, whether personally or on behalf of an entity (“you”) and Termly LLC (“we,” “us” or “our”)."
}

Response Parameters

Parameter Name	Type	Description
tncUpdateYn	String	Returns 'Y' if TnC updated since last check
categoryUpdateYn	String
faqUpdateYn	String	Returns 'Y' if FAQ's updated since last check
tncUpdatedServices	String
TnC	String	Terms and conditions

Get FAQ Category List

Retrieve FAQs category of your tenant service.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/getFaqCategoryList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get FAQ Category Request

{}

Request Parameters

None

Get FAQ Category Response

{
  "result": {
    "code": 0
  },
  "updDtim": "2018-11-13T19:06:14.000+0000",
  "faqCategoryList": [
    {
      "faqCategoryId": "BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720",
      "faqCategoryName": "Application"
    },
    {
      "faqCategoryId": "13B01087-BD04-40AE-BD30-CDF9283FBA84",
      "faqCategoryName": "Coupons"
    },
    {
      "faqCategoryId": "62147270-1185-4A1C-A863-83E2BEE8E6E7",
      "faqCategoryName": "Digital Gift Card"
    }
  ]
}

Response Parameters

Name	Value/Range	Description
updDtim	String	Last update date time. Using this, client determine data refresh if it caches FAQ in its local storage.Format is yyyy-MM-dd’T’HH:mm:ss.SZ
faqCategoryId	String	Unique identifier of a FAQ category.
faqCategoryName	String	Name of FAQ category.

Get FAQ List

Retrieve full contents of FAQ.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/getFaqList
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get FAQ List Request

{"categoryId":"BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720"}

Request Parameters

Name	Required	Description	Value/Range
categoryId	yes	Unique identifier of a FAQ category. e.g. BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720	String

Get FAQ List Response

{
  "result": {
    "code": 0
  },
  "faqList": [
    {
      "faqId": "F558AEC8-1352-4489-87A3-9E76604608F6",
      "categoryId": "BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720",
      "question": "What type of phones are supported?",
      "answer": "The App can be used on both the iPhone® and Android phones."
    },
    {
      "faqId": "857DA88B-748D-4DBA-A06F-73AA895268DC",
      "categoryId": "BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720",
      "question": "What if I forget my PIN?",
      "answer": "From the login screen, tap “Forgot PIN” you will be prompted for your Password and Security Question."
    },
    {
      "faqId": "0999371A-367F-4A03-B394-ABA2460CC84F",
      "categoryId": "BEA1D7D7-FD9A-4BB2-B95E-B0C1376F5720",
      "question": "How can I locate a store?",
      "answer": "Tap “Store Locator” from the App Menu Screen and enter a city/state or ZIP code to locate a store anywhere in the United States. Use the “Filter” icon to sort locations according to features."
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
faqId	String	Unique identifier of a FAQ category.
categoryId	String	Name of FAQ category.
question	String	FAQ Question
answer	String	FAQ answer

Get User Configuration

Retrieve end user’s inbox messaging opt in status.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/getUserConfig
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get User configuration Request

{}

Request Parameters

None

Get User Configuration Response

{
  "result": {
    "code": 0
  },
  "inboxOptOutYn": "N"
}

Response Parameters

Parameter Name	Type	Description
inboxOptOutYn	String	Indicate if end user opted in inbox message service. Possible values are 'Y' or 'N'

Get Wallet T&C

Retrieve Terms and Conditions of your wallet service.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/getWalletTnc
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get wallet T&C Request

{"walletId":"JANUS"}

Request Parameters for TargetingAttribute

Name	Required	Description	Value/Range
walletId	yes	Your tenant name. e.g. JANUS	String

Get wallet T&C Response

{
  "result": {
    "code": 0
  },
  "tnc": "Default TnC.\nThese Terms of Use constitute a legally binding agreement made between you, whether personally or on behalf of an entity (“you”) and Termly LLC (“we,” “us” or “our”).",
  "serviceTerms": []
}

Response Parameters

Parameter Name	Type	Description
tnc	String	Terms and conditions
serviceTerms	String

Register Push Info

Supply end user’s push type and push ID to be used for future communication using push message.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/registerPushInfo
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Register end user’s push type and push ID Request

{"pushId":"76b39c2b2ceaadee8400b8868c2f45325ab9831c1998ed70859d86","pushType":"APNS"}

Request Parameters

Name	Required	Description	Value/Range
pushType	yes	Type of push that mobile device supports. Possible values are: - APNS : Apple APNS push service - BPPG: Blackberry push service - C2DM: Android C2DM push service - MDP: MDP - SOCKET: Android SOCKET push service - GCM: Android GCM push service - FCM : Android Firebase Cloud Messaging, to be updated.	String
pushId	yes	End user’s unique push identifier provided from the push service.	String

Register end user’s push type and push ID Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

None.

Renew Wallet Consent T&C

Store end user’s agreement with Terms and Conditions.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/renewWalletConsent
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Renew Wallet Consent T&C Request

{"consentYn":"Y"}

Request Parameters

Name	Required	Description	Value/Range
consentYn	yes	End user’s T&C agreement.	String

Renew Wallet Consent T&C Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Response code

Restore Backup Client

Retrieve your customized end user data stored in the server.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/restoreClient
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Restore Backup Client Request

{}

Request Parameters

None.

Restore Backup Client Response

{
  "result": {
    "code": 0
  },
  "data": "{contactlessStatus:false,isOptIn:false,mayAskActivate:true,mayAskIF:false}",
  "elementList": [
    {
      "elementName": "FAVORITE_CATEGORY",
      "valueSeq": 1,
      "elementValue": "100,200,300"
    },
    {
      "elementName": "2354FE7A-7F27-45BA-A46D-52E6CC06B00B",
      "valueSeq": 1,
      "elementValue": "Mexican"
    },
    {
      "elementName": "FAVORITE_MERCHANT",
      "valueSeq": 1,
      "elementValue": "80277822-10DA-4829-8708-7636DED7944C"
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
elementName	String	Name of the element
elementValue	String	Value of the element

Set User Configuration

missing

Get Wallet User

Retrieve end user’s information including end user’s personal information and preference information to be used for marketing purpose.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/getWalletUser
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Wallet User Request

{}

Request Parameters

None.

Get Wallet User Response

{
  "result": {
    "code": 0
  },
  "walletUser": {
    "email": "johndoe@test.com",
    "firstName": "John",
    "lastName": "Doe",
    "inboxOptOutYn": "N",
    "contactEmail": "john.doe@test.com",
    "userId": "420186A78B1548E7A10D93E2AB072EFA",
    "userPrefList": [
      {
        "tgtAttrId": "7966E1C7-D905-464A-8484-6CE5ECBC40DE",
        "tgtAttrName": "Favorite visiting time",
        "tgtAttrValueList": [
          {
            "tgtAttrValue": "Afternoon",
            "selectedYn": "Y"
          },
          {
            "tgtAttrValue": "Evening",
            "selectedYn": "N"
          },
          {
            "tgtAttrValue": "Morning",
            "selectedYn": "N"
          }
        ]
      },
      {
        "tgtAttrId": "2354FE7A-7F27-45BA-A46D-52E6CC06B00B",
        "tgtAttrName": "Foods",
        "tgtAttrValueList": [
          {
            "tgtAttrValue": "American",
            "selectedYn": "Y"
          },
          {
            "tgtAttrValue": "French",
            "selectedYn": "N"
          },
          {
            "tgtAttrValue": "Mexican",
            "selectedYn": "N"
          }
        ]
      },
      {
        "tgtAttrId": "2D1C6311-34A5-4855-8DC3-FC156B81A4B0",
        "tgtAttrName": "Shopping habits",
        "tgtAttrValueList": [
          {
            "tgtAttrValue": "Monthly",
            "selectedYn": "N"
          },
          {
            "tgtAttrValue": "Shopaholic",
            "selectedYn": "N"
          },
          {
            "tgtAttrValue": "Weekly",
            "selectedYn": "N"
          }
        ]
      },
      {
        "tgtAttrId": "A33C881AC5D14287BD7C5C58E45AF669",
        "tgtAttrName": "Sports",
        "tgtAttrValueList": [
          {
            "tgtAttrValue": "Baseball",
            "selectedYn": "y"
          },
          {
            "tgtAttrValue": "Golf",
            "selectedYn": "N"
          },
          {
            "tgtAttrValue": "Tennis",
            "selectedYn": "N"
          }
        ]
      }
    ],
    "customAttributeList": [
      {
        "name": "FAVORITE_MERCHANT",
        "value": "80277822-10DA-4829-8708-7636DED7944C"
      }
    ]
  }
}

Response Parameters

Parameter Name	Type	Description
email	String	End user’s email
firstName	String	End user’s first name
lastName	String	End user’s last name
gender	String	End user’s gender. Possible values are MALE and FEMALE.
age	String	End user’s age
inboxOptOutYn	String	Deprecated. Check the configuration returned from getUserConfig(). Indicate if end user opted in inbox message service. Possible values are: - Y: End user opted in inbox message service. - N: End user didn’t opt in inbox message service.
birthMonth	String	End user’s birth month
birthday	String	End user’s birthday
birthyear	String	End user’s birth year
contactEmail	String	End user’s contact email.
phoneNumber	String	End user’s phone number
loyaltyId	String	End user’s loyalty ID
userid	String	End user’s unique identifier in Cloud payment platform
alternativeId	String	End user’s alternative ID
userPerfList	List<TargetingAttribute	List of categories in user targeting attribute
customAttributeList	ListCustomAttribute	List of your customized attributes
tgtAttrId	String	Unique identifier of user targeting attribute
tgtAttrName	String	Name of user targeting attribute. e.g. Sports
tgtAttrValueList	List TargetingAttributeCode	List of items in this user targeting attribute
tgtAttrValue	String	End user targeting attribute item. e.g. Baseball, Golf, Tennis, etc.
selectedYn	String	End user’s selection for the targeting attribute item. Possible values are: - Y: End user chose the item. - N: End user doesn’t choose the item.
name	String	Name of custom attributes.
value	String	Value of the attribute.

Update Wallet User Information

Update end user’s information including end user’s personal information and preference information to be used for marketing purpose.

Key	Value
Method	POST
Resource URL	{Wallet_URL}/v4/updateWalletUser
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only since entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Update Wallet User Information Request

{
    "walletUser": {
        "email": "john.doe@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "inboxOptOutYn": "N",
        "contactEmail": " john.doe@example.com ",
        "userId": "420186A78B1548E7A10D93E2AB072EFA",
        "userPrefList": [{
            "tgtAttrId": "7966E1C7-D905-464A-8484-6CE5ECBC40DE",
            "tgtAttrName": "Favorite visiting time",
            "tgtAttrValueList": [{
                "tgtAttrValue": "Afternoon",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Evening",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Morning",
                "selectedYn": "N"
            }]
        }, {
            "tgtAttrId": "2354FE7A-7F27-45BA-A46D-52E6CC06B00B",
            "tgtAttrName": "Foods",
            "tgtAttrValueList": [{
                "tgtAttrValue": "American",
                "selectedYn": "Y"
            }, {
                "tgtAttrValue": "Chinese",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "French",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Italian",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Korean",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Mexican",
                "selectedYn": "Y"
            }]
        }, {
            "tgtAttrId": "2D1C6311-34A5-4855-8DC3-FC156B81A4B0",
            "tgtAttrName": "Shopping habits",
            "tgtAttrValueList": [{
                "tgtAttrValue": "Monthly",
                "selectedYn": "Y"
            }, {
                "tgtAttrValue": "Shopaholic",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Weekly",
                "selectedYn": "N"
            }]
        }, {
            "tgtAttrId": "A33C881AC5D14287BD7C5C58E45AF669",
            "tgtAttrName": "Sports",
            "tgtAttrValueList": [{
                "tgtAttrValue": "Baseball",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Golf",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Tennis",
                "selectedYn": "N"
            }]
        }, {
            "tgtAttrId": "B1989FE05F11431AAA6339EFAD79AA2A",
            "tgtAttrName": "Weather2",
            "tgtAttrValueList": [{
                "tgtAttrValue": "Cloudy2",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Rainy2",
                "selectedYn": "N"
            }, {
                "tgtAttrValue": "Sunny2",
                "selectedYn": "N"
            }]
        }],
        "customAttributeList": [{
            "name": "FAVORITE_MERCHANT",
            "value": "80277822-10DA-4829-8708-7636DED7944C"
        }]
    }
}

Request Parameters

Name	Required	Description	Value/Range
email	yes	String	End user’s email
firstName	yes	String	End user’s first name
lastName	yes	String	End user’s last name
gender	no	String	End user’s gender. Possible values are MALE and FEMALE.
age	no	String	End user’s age
inboxOptOutYn	no	String	Deprecated. Check the configuration returned from getUserConfig(). Indicate if end user opted in inbox message service. Possible values are: - Y: End user opted in inbox message service. - N: End user didn’t opt in inbox message service.
birthMonth	no	String	End user’s birth month
birthday	no	String	End user’s birthday
birthyear	no	String	End user’s birth year
contactEmail	no	String	End user’s contact email.
phoneNumber	no	String	End user’s phone number
loyaltyId	no	String	End user’s loyalty ID
userid	no	String	End user’s unique identifier in Fintiv platform
alternativeId	no	String	End user’s alternative ID
userPerfList	no	List<TargetingAttribute	List of categories in user targeting attribute
customAttributeList	no	List CustomAttribute	List of your customized attributes
tgtAttrId	yes	String	Unique identifier of user targeting attribute
tgtAttrName	yes	String	Name of user targeting attribute. e.g. Sports
tgtAttrValueList	no	ListTargetingAttributeCode	List of items in this user targeting attribute
tgtAttrValue	yes	String	End user targeting attribute item. e.g. Baseball, Golf, Tennis, etc.
selectedYn	no	String	End user’s selection for the targeting attribute item. Possible values are: - Y: End user chose the item. - N: End user doesn’t choose the item.
name	yes	String	Name of custom attributes.
value	no	String	Value of the attribute.

Update Wallet User Information Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

None.

Get Recommended Coupon

Returns the recommended coupon shared by an end user.

Key	Value
Method	GET
Resource URL	{Offers_URL}/v4/share/detail/{service_id}/{couponid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Recommended Coupon Request

{

}

Request Parameters

None.

Get Recommended Coupon Response

{
  "empty": true,
  "model": {},
  "modelMap": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "reference": true,
  "status": "100",
  "view": {
    "contentType": "string"
  },
  "viewName": "string"
}

Response Parameters

Parameter Name	Type	Description
recommendUrl	string	URL of the Recommended Coupon
code	integer	Response code
message	string

Activate Coupons

Set the status of one or more coupon instances to active. Supply the unique coupon instance ID that was returned from previous 'View my coupons' request.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/activateCoupons
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Activate Coupons Request

{
           "couponInstanceIdList": ["71722408-490C-4138-A211-E204BFD9A36B"]
}

Request Parameters

Name	Required	Description	Value/Range
serviceId	No	Unique identifier for the offer service.	String
couponInstanceIdList	Yes	List of coupon instance IDs to be updated. e.g.["71722408-490C-4138-A211-E204BFD9A36B”]	String[]

Activate Coupons Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Name	Description	Value/Range
code	response code	Integer
message		string

Set Favorite Merchant

Assign a list of merchants as the end user’s favorite merchants.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/setFavoriteMerchant
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Set Favorite Merchants Request

{
  "merchantIds": [ "80277822-10DA-4829-8708-7636DED7944C"]
}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.
merchantIds	Yes	String	List of merchant IDs [“80277822-10DA-4829-8708-7636DED7944C”]

Set Favorite Merchants Response

{
  "result": {
    "code": 0
  }
}

Response Parameters

Parameter Name	Type	Description
code	integer	Response code
message	string

Get Favorite Merchant

Retrieve end user’s list of favorite merchants.

Key	Value
Method	POST
Resource URL	{Offers_URL}/v4/getFavoriteMerchant
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Favorite Merchants Request

{}

Request Parameters

Parameter Name	Required	Type	Description
serviceId	No	String	Unique identifier for the offer service.

Get Favorite Merchants Response

{
  "result": {
    "code": 0
  },
  "merchantIds": [
    "80277822-10DA-4829-8708-7636DED7944C"
  ]
}

Response Parameters

Parameter Name	Type	Description
merchantIds	String	Identifier of merchant where the coupon can be redeemed.
code	integer	Response code
message	String

Get Recommended Coupon

Returns the recommended coupon shared by an end user.

Key	Value
Method	GET
Resource URL	{Offers_URL}/v4/share/detail/{service_id}/{couponid}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Get Recommended Coupon Request

{

}

Request Parameters

None.

Get Recommended Coupon Response

{
  "empty": true,
  "model": {},
  "modelMap": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "reference": true,
  "status": "100",
  "view": {
    "contentType": "string"
  },
  "viewName": "string"
}

Response Parameters

Parameter Name	Type	Description
recommendUrl	string	URL of the Recommended Coupon
code	integer	Response code
message	string

Download and Save Recommended Coupon

Download and save the recommended coupon by the anonymous user or application. No login is required.

Key	Value
Method	GET
Resource URL	{Offers_URL}/v4/share/entry/{service_id}/{couponId}
Request Headers	application/json text/plain
Response Formats	application/json text/plain; charset=utf-8
Required Authentication	Yes

Header Parameter

Key	Value
Content-Type	application/json
tenantName	Tenant name. Upper case only. Entry is case sensitive
api-key	{API-Key} TYK Key
Authorization	Bearer {sub_token}

Download recommended coupon Request

{

}

Request Parameters

None.

Download Recommended Coupon Response

{
  "empty": true,
  "model": {},
  "modelMap": {
    "additionalProp1": {},
    "additionalProp2": {},
    "additionalProp3": {}
  },
  "reference": true,
  "status": "100",
  "view": {
    "contentType": "string"
  },
  "viewName": "string"
}

Response Parameters

Parameter Name	Type	Description
empty	Boolean
reference	Boolean
status	string
contentType	String
viewName	String

Errors

The API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The resource requested is hidden for administrators only.
404	Not Found -- The specified resource could not be found.
405	Method Not Allowed -- You tried to access a resource with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The resource requested has been removed from our servers.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.