User Points History
Overview
Requests to this endpoint will retrieve a summary of the reward points which a user has earned from service. It includes points which have been earned from the completion of campaigns or from purchases from the PlayStation Store, and points which have been redeemed either on collectibles or rewards like PlayStation Store credit and games.
The endpoint can query the authenticating account only.
https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory
If you query with an account which has not enrolled with PlayStation Stars then the API will return a successful but empty response.
Click to view full response
{
"data": {
"loyaltyPointHistoryRetrieve": []
}
}
Input Parameters
Parameter | Value |
---|---|
operationName | metGetPointsHistory |
variables | {} |
extensions | {"persistedQuery":{"version":1,"sha256Hash":"302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c"}} |
Output JSON Response
A JSON response is returned. The following are returned under the data
attribute.
Attribute | Type | Example Value | Description |
---|---|---|---|
loyaltyPointHistoryRetrieve | JSON objectLoyaltyPointHistoryRecord | Contains a collection of objects which detail each time the account has earned or redeemed points |
LoyaltyPointHistoryRecord JSON object
Attribute | Type | Example Response | Description |
---|---|---|---|
__typename | String | LoyaltyPointHistoryRecord | |
displayPoints | String | 700 -1,250 | Points earned or redeemed (string formatted) |
eventDateTime | Date (UTC) | 2022-11-02T20:21:28.891Z | Date of the transaction |
eventType | String | PURCHASE WALLET_CREDIT CAMPAIGN COLLECTIBLE | Type of transaction |
points | Numeric | 700 -1250 | Points earned or redeemed |
referenceData | JSON objectLoyaltyRewardRecord JSON object LoyaltyPurchaseRecord | Data associated with how the points were earned or redeemed |
LoyaltyRewardRecord JSON object
Attribute | Type | Example Response | Description |
---|---|---|---|
__typename | String | LoyaltyRewardRecord | |
id | String | 8fc3abdc-bf5b-5f7f-8a44-a9c2c50837b7 7a258750-c495-5a79-a94d-5e450f4bc2bc | GUID of the reward associated with the points (usually a campaign or collectible) |
name | String | Play Wherever Hans | tortured artist capsule | Name of the reward |
LoyaltyPurchaseRecord JSON object
Attribute | Type | Example Response | Description |
---|---|---|---|
__typename | String | LoyaltyPurchaseRecord | |
id | String | 000000000000 | PlayStation Store transaction number associated with the points |
name | String | God of War Ragnarök null | Name of the PlayStation Store product |
Examples with Responses
Example 1 - Retrieve points history for the authenticating account (Purchase, Campaign and Wallet Credit)
- Encoded URL
- Raw URL
- PowerShell
See using a Web Browser to query the API
https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables=%7B%7D&extensions=%7B%22persistedQuery%22%3A%7B%22version%22%3A1%2C%22sha256Hash%22%3A%22302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c%22%7D%7D
See using a Web Browser to query the API
https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables={}&extensions={"persistedQuery":{"version":1,"sha256Hash":"302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c"}}
See using PowerShell to query the API
Invoke-RestMethod -Uri 'https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables={}&extensions={"persistedQuery":{"version":1,"sha256Hash":"302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c"}}' -Authentication Bearer -Token $token
Click to view full JSON response
{
"data": {
"loyaltyPointHistoryRetrieve": [
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "700",
"eventDateTime": "2022-10-18T16:20:08.672Z",
"eventType": "PURCHASE",
"points": 700,
"referenceData": {
"__typename": "LoyaltyPurchaseRecord",
"id": "000000000000",
"name": "Call of Duty®: Modern Warfare® II - Cross-Gen Bundle"
}
},
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "75",
"eventDateTime": "2022-11-01T13:45:05.822851Z",
"eventType": "CAMPAIGN",
"points": 75,
"referenceData": {
"__typename": "LoyaltyRewardRecord",
"id": "8fc3abdc-bf5b-5f7f-8a44-a9c2c50837b7",
"name": "Play wherever"
}
},
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "700",
"eventDateTime": "2022-11-02T20:21:28.891Z",
"eventType": "PURCHASE",
"points": 700,
"referenceData": {
"__typename": "LoyaltyPurchaseRecord",
"id": "000000000000",
"name": "God of War Ragnarök"
}
},
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "-1,250",
"eventDateTime": "2022-11-02T22:24:08.201225Z",
"eventType": "WALLET_CREDIT",
"points": -1250,
"referenceData": {
"__typename": "LoyaltyPurchaseRecord",
"id": "000000000000",
"name": null
}
}
]
}
}
Example 2 - Retrieve points history for the authenticating account (Purchase and Collectible)
- Encoded URL
- Raw URL
- PowerShell
See using a Web Browser to query the API
https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables=%7B%7D&extensions=%7B%22persistedQuery%22%3A%7B%22version%22%3A1%2C%22sha256Hash%22%3A%22302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c%22%7D%7D
See using a Web Browser to query the API
https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables={}&extensions={"persistedQuery":{"version":1,"sha256Hash":"302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c"}}
See using PowerShell to query the API
Invoke-RestMethod -Uri 'https://m.np.playstation.com/api/graphql/v1/op?operationName=metGetPointsHistory&variables={}&extensions={"persistedQuery":{"version":1,"sha256Hash":"302481c4156ec3f64332bf4b76251597eb30825a79e2736641737bc3af77755c"}}' -Authentication Bearer -Token $token
Click to view full JSON response
{
"data": {
"loyaltyPointHistoryRetrieve": [
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "450",
"eventDateTime": "2022-10-13T12:37:08.54Z",
"eventType": "PURCHASE",
"points": 450,
"referenceData": {
"__typename": "LoyaltyPurchaseRecord",
"id": "000000000000",
"name": "3,280 Genesis Crystals"
}
},
{
"__typename": "LoyaltyPointHistoryRecord",
"displayPoints": "-200",
"eventDateTime": "2022-10-29T21:41:32.252532Z",
"eventType": "COLLECTIBLE",
"points": -200,
"referenceData": {
"__typename": "LoyaltyRewardRecord",
"id": "7a258750-c495-5a79-a94d-5e450f4bc2bc",
"name": "Hans | tortured artist capsule"
}
}
]
}
}