Loyalty Points Summary
Description¶
The loyaltyPointsSummary endpoint is used to retrieve a detailed summary of the total points accumulated by a user within a specific Loyalty Rewards Program.
Request¶
Endpoint¶
/ui/v1/loyaltyPointsSummaryMethod¶
POSTHeader¶
Content-Type: application/json
Request Body¶
{
"startDate": "2025-04-04",
"endDate": "2025-07-03",
"transactionOwnerId": [
"692"
],
"pointsCategory": [],
"merchantId": "42"
}
Response¶
{
"records": [
{
"id": 10,
"createdDateTime": 1749406024000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 2600,
"pointsCategory": {
"name": "PENDING"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Reservation #8999",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 9,
"createdDateTime": 1749406024000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 3000,
"pointsCategory": {
"name": "REDEEMED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Redeemed Points on Champagne Purchase",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 8,
"createdDateTime": 1749406023000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 2900,
"pointsCategory": {
"name": "TRANSFERRED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Points Transferred to Recipient (XXXX 1234)",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 7,
"createdDateTime": 1749406023000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 900,
"pointsCategory": {
"name": "EARNED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Partner Points Earned (Car Booking)",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 6,
"createdDateTime": 1749406023000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 4000,
"pointsCategory": {
"name": "EARNED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Ticket Purchase",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 5,
"createdDateTime": 1749406022000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 1000,
"pointsCategory": {
"name": "BONUS"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Bonus Points (Promotional)",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 4,
"createdDateTime": 1749406022000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 5000,
"pointsCategory": {
"name": "PURCHASED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Points Purchased",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 3,
"createdDateTime": 1749406022000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 300,
"pointsCategory": {
"name": "EARNED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Room Upgrade",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 2,
"createdDateTime": 1749406021000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 1200,
"pointsCategory": {
"name": "EARNED"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Purchase towards Ticket # AB12CX",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
},
{
"id": 1,
"createdDateTime": 1749406021000,
"lastUpdatedDateTime": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdUserId": 692,
"lastModifiedUserId": null,
"money": null,
"numberOfPoints": 500,
"pointsCategory": {
"name": "ENROLLMENT"
},
"loyaltyIssuanceId": null,
"loyaltyRedemptionId": null,
"transactionOwnerId": 692,
"description": "Welcome Kickstarter Points",
"transactionInfoId": null,
"transactionInfoOrderId": null,
"merchantId": 42,
"createdUserName": null,
"fullName": "Customer User Velaatlanta",
"loyaltyRewardsNumber": 10000000000004,
"transactionOwnerUserName": null,
"strCreatedDateTime": "2025-06-08 01:07 PM -05:00",
"message": null,
"merchantName": null
}
],
"recordCount": null,
"message": null
}
Updated As Of Version 6.6.x