Activate

APIs

Check if mobile client update is needed

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.

Precondition

None.

Request

HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/activate/{version}/checkWalletUpdate

Body parameters

Parameters	Type	Required	Note
osName	String	Required	OS name of end user’s mobile device. Possible values are ANDROID and IOS.
walletId	String	Required	Your tenant name. e.g. JANUS
version	String	Required	Version of wallet service currently installed on end user’s device.

Example request

curl -X POST "http://api-dev.fintiv.co:8080/activate/v4/checkWalletUpdate"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "Content-Type: application/json"
-d ‘{"osName":"ANDROID","version":"1.0","walletId":"JANUS"}’

Response

Returns Indication of a new version availability. If available, detail info of the new update is returned.

Body parameters

Parameters	Type	Required	Note
existUpdateVersion	String	Required	Indicates if new version to be updated available. Possible value is Y and N.
mandatoryYn	String	Conditional	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.
updateVersion	String	Conditional	New version number to be updated. Custom value depending on tenant. If existUpdateVersion has value ‘Y’, this parameter is available. e.g. 2.0
downloadUrl	String	Conditional	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

Example response

• When there is no available new version

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

• 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"
}

Retrieve list of skins to be monitored

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

Precondition

Client logged in the service. Refer the section for registration/authentication.

Request

HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/activate/{version}/getUserPrefList

Example request

curl -X POST "http://api-dev.fintiv.co:8080/activate/v4/getUserPrefList"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "Content-Type: application/json"
-d ‘{"walletId":"JANUS"}’

Response

Returns list of user preferences

Body parameters

• TargetingAttribute

Parameters	Type	Required	Note
tgtAttrId	String	Required	Unique identifier of user targeting attribute
tgtAttrName	String	Required	Name of user targeting attribute. e.g. Sports.
tgtAttrValueList	List<TargetingAttributeCode>	Optional	List of items in this user targeting attribute

• TargetingAttributeCode

Parameters	Type	Required	Note
tgtAttrValue	String	Required	End user targeting attribute item. e.g. Baseball, Golf, Tennis, etc.

Example 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"
        }
      ]
    }
  ]
}