Skip to main content

Reward Detail

Overview​

Requests to this endpoint will retrieve the details of a specific reward.

The endpoint can only query the collectible and wallet credit rewards. Product rewards (ie. full games) are directed to the PlayStation Store's API which is beyond the scope of this documentation.

The endpoint can query the authenticating account only.

https://m.np.playstation.com/api/graphql/v1/op?operationName=metLoyaltyRewardbyId
info

If you query with an account which has not enrolled with PlayStation Stars then the API will return a successful response with an error object contained within.

Click to view full response
{
  "errors": [
    {
      "message": "User is not enrolled inside the program!",
      "type": "NimbusNormalizedError",
      "error": {
        "reason": "BadRequest",
        "source": "-1",
        "code": -1,
        "message": "User is not enrolled inside the program!",
        "referenceId": "aa8f9436-259b-402d-b9c1-c2a0a34c74b4"
      },
      "statusCode": 400,
      "errorCode": -1,
      "humanReadableCode": "",
      "humanReadableValidationErrors": [],
      "apiName": "getRewardById"
    }
  ],
  "data": {
    "loyaltyRewardbyIdRetrieve": null
  }
}

Input Parameters​

ParameterValue
operationNamemetLoyaltyRewardbyId
variables{"id":"85bc1d70-a9ee-55e7-a97d-905ee2d82a48"}
extensions{"persistedQuery":{"version":1,"sha256Hash":"ce95956c322a6a6a83def21efd4471cf1f617a2259c1e9c52b4a2c2109005cdd"}}
PropertyParent ParameterTypeExample ValuesDescriptionRequired
idvariablesString85bc1d70-a9ee-55e7-a97d-905ee2d82a48GUID of the reward to retrieveYes

Output JSON Response​

A JSON response is returned. The following are returned under the data attribute.

AttributeTypeExample ValueDescription
loyaltyRewardbyIdRetrieveJSON object
LoyaltyRewardCollectible
JSON object
LoyaltyRewardWalletCredit		Contains the reward details

LoyaltyRewardCollectible JSON object​

AttributeTypeExample ResponseDescription
__typenameStringLoyaltyUserCollectible
assetsJSON object
Media		Media associated with the collectible (images, video)
descriptionsJSON object
Description		Description associated with the collectible
displayNameStringPink Monkey DioramaName of the collectible
displayPointsString200Cost of the reward (string formatted)
idString85bc1d70-a9ee-55e7-a97d-905ee2d82a48ID for the reward
nameStringPink Monkey DioramaName of the collectible
offerEndDateDate (UTC)2022-11-15T23:59:00.000000ZDate the collectible removed from the reward store
offerStartDateDate (UTC)2022-09-13T21:24:00.000000ZDate the collectible added to the reward store
pointsNumeric200Cost of the reward
rarityStringCOMMON
UNCOMMON
RARE
HEROIC
LEGENDARY		Rarity of the collectible
releaseDateDate (UTC)2022-09-13T00:00:00.000000ZDate the collectible became available
rewardTypeStringCOLLECTIBLEType of reward
unlockedDateDate (UTC)2022-10-01T13:06:01.004772Z
null		Date the user earned the collectible
null if not earned

Media (Collectible) JSON object​

AttributeTypeExample ResponseDescription
__typenameStringMedia
typeStringIMAGE
VIDEO		The media type
urlStringhttps://sky-assets.api.playstation.com/sky/p1-np/collectible/image/masterImage_png_418_1664306106337.png
https://sky-assets.api.playstation.com/sky/p1-np/collectible/video/video_mp4_418_1662589943734.mp4		URL for the media

Description (Collectible) JSON object​

AttributeTypeExample ResponseDescription
__typenameStringDescription
typeStringLEGAL
LONG		The description type
urlStringnull
Escape the ape that's in you with the help of this totally stable aspiring pop star.		Description text

LoyaltyRewardWalletCredit JSON object​

tip

Wallet credit rewards appear to be listed as generic dollar values (ie. $5, $20) with the monetaryValue attribute displaying the actual localised value of the credit.

AttributeTypeExample ResponseDescription
__typenameStringLoyaltyRewardWalletCredit
assetsJSON object
Media		Media associated with the wallet credit (images, video)
descriptionsJSON object
Description		Description associated with the wallet credit
displayNameStringWallet Credit - $20Name of the wallet credit
displayPointsString4,000Cost of the reward (string formatted)
idString18747538-8dce-569c-91b8-3d46bc1c7296ID for the reward
localizedProductClassificationsArray
String		nullType of product
monetaryValueStringHK$160.00Value of the wallet credit
nameStringWallet Credit - $20Name of the wallet credit
offerEndDateDate (UTC)2023-12-31T23:59:00.000000ZDate the wallet credit removed from the reward store
offerStartDateDate (UTC)2022-09-27T01:51:00.000000ZDate the wallet credit added to the reward store
pointsNumeric4000Cost of the reward
rewardTypeStringCOLLECTIBLEType of reward

Media (Wallet) JSON object​

AttributeTypeExample ResponseDescription
__typenameStringMedia
roleStringIMAGE
TILE
BACKGROUND		What the media is used for
typeStringIMAGEThe media type
urlStringhttps://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_11_center.png
https://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_11_topaligned.png
https://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_169_center.png		URL for the media

Description (Wallet) JSON object​

AttributeTypeExample ResponseDescription
__typenameStringDescription
typeStringLEGAL
LONG		The description type
valueStringnull
Wallet Credit - $20		Description text

Examples with Responses​

Example 1 - Retrieve collectible reward with id 85bc1d70-a9ee-55e7-a97d-905ee2d82a48 for the authenticating account​

See using a Web Browser to query the API

https://m.np.playstation.com/api/graphql/v1/op?operationName=metLoyaltyRewardbyId&variables=%7B%22id%22%3A%2285bc1d70-a9ee-55e7-a97d-905ee2d82a48%22%7D&extensions=%7B%22persistedQuery%22%3A%7B%22version%22%3A1%2C%22sha256Hash%22%3A%22ce95956c322a6a6a83def21efd4471cf1f617a2259c1e9c52b4a2c2109005cdd%22%7D%7D
Click to view full JSON response
{
  "data": {
    "loyaltyRewardbyIdRetrieve": {
      "__typename": "LoyaltyRewardCollectible",
      "assets": [
        {
          "__typename": "Media",
          "type": "IMAGE",
          "url": "https://sky-assets.api.playstation.com/sky/p1-np/collectible/image/masterImage_png_418_1664306106337.png"
        },
        {
          "__typename": "Media",
          "type": "VIDEO",
          "url": "https://sky-assets.api.playstation.com/sky/p1-np/collectible/video/video_mp4_418_1662589943734.mp4"
        }
      ],
      "description": [
        {
          "__typename": "Description",
          "type": "LEGAL",
          "value": null
        },
        {
          "__typename": "Description",
          "type": "LONG",
          "value": "Escape the ape that's in you with the help of this totally stable aspiring pop star."
        }
      ],
      "displayName": "Pink Monkey Diorama",
      "displayPoints": "200",
      "id": "85bc1d70-a9ee-55e7-a97d-905ee2d82a48",
      "name": "Pink Monkey Diorama",
      "offerEndDate": "2022-11-15T23:59:00.000000Z",
      "offerStartDate": "2022-09-13T21:24:00.000000Z",
      "points": 200,
      "rarity": "RARE",
      "releaseDate": "2022-09-13T00:00:00.000000Z",
      "rewardType": "COLLECTIBLE",
      "unlockedDate": null
    }
  }
}

Example 2 - Retrieve wallet credit reward with id 18747538-8dce-569c-91b8-3d46bc1c7296 for the authenticating account​

See using a Web Browser to query the API

https://m.np.playstation.com/api/graphql/v1/op?operationName=metLoyaltyRewardbyId&variables=%7B%22id%22%3A%2218747538-8dce-569c-91b8-3d46bc1c7296%22%7D&extensions=%7B%22persistedQuery%22%3A%7B%22version%22%3A1%2C%22sha256Hash%22%3A%22ce95956c322a6a6a83def21efd4471cf1f617a2259c1e9c52b4a2c2109005cdd%22%7D%7D
Click to view full JSON response
{
  "data": {
    "loyaltyRewardbyIdRetrieve": {
      "__typename": "LoyaltyRewardWalletCredit",
      "assets": [
        {
          "__typename": "Media",
          "role": "IMAGE",
          "type": "IMAGE",
          "url": "https://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_11_center.png"
        },
        {
          "__typename": "Media",
          "role": "TILE",
          "type": "IMAGE",
          "url": "https://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_11_topaligned.png"
        },
        {
          "__typename": "Media",
          "role": "BACKGROUND",
          "type": "IMAGE",
          "url": "https://sky-assets.api.playstation.com/sky/p1-np/walletCredit/image/walletcredit_169_center.png"
        }
      ],
      "description": [
        {
          "__typename": "Description",
          "type": "LEGAL",
          "value": null
        },
        {
          "__typename": "Description",
          "type": "LONG",
          "value": "Wallet Credit - $20"
        }
      ],
      "displayName": "Wallet Credit - $20",
      "displayPoints": "4,000",
      "id": "18747538-8dce-569c-91b8-3d46bc1c7296",
      "localizedProductClassifications": [],
      "monetaryValue": "HK$160.00",
      "name": "Wallet Credit - $20",
      "offerEndDate": "2023-12-31T23:59:00.000000Z",
      "offerStartDate": "2022-09-27T01:51:00.000000Z",
      "points": 4000,
      "rewardType": "WALLET_CREDIT"
    }
  }
}