Get Statement Summary
Transactions
Get Statement Summary
Retrieve a member’s aggregated points balance and loyalty statement totals.
POST
Get Statement Summary
Returns a member’s aggregated loyalty account summary — total points earned, redeemed, expired, and the current redeemable balance. This is the primary endpoint for a loyalty wallet or dashboard screen where you want to show a member their overall standing at a glance.
ReturnObject.PointBalance is the live redeemable balance to use in redemption eligibility checks. For a line-by-line transaction history, use Get Transaction Summary.
Responses
200 — Success
200 — Success
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | true |
results.ErrorCode | string | 000 |
results.ReturnObject.PointBalance | integer | Current redeemable points balance |
results.ReturnObject.Bonus | integer | Points earned through bonus/referral campaigns |
results.ReturnObject.Spend | integer | Points earned through purchase transactions |
results.ReturnObject.Redeem | integer | Total points redeemed |
results.ReturnObject.Partner | integer | Points earned through partner transactions |
results.ReturnObject.Purchased | integer | Points purchased directly |
results.ReturnObject.OtherAccrued | integer | Points earned through other accrual types |
results.ReturnObject.Air | integer | Points redeemed for air bookings |
results.ReturnObject.Hotel | integer | Points redeemed for hotel bookings |
results.ReturnObject.Car | integer | Points redeemed for car bookings |
results.ReturnObject.BillPayment | integer | Points redeemed for bill payments |
results.ReturnObject.Charity | integer | Points donated to charity |
results.ReturnObject.CreditTransfer | integer | Points received via transfer |
results.ReturnObject.DebitTransfer | integer | Points sent via transfer |
results.ReturnObject.ExpiredPoints | integer | Total expired points |
Error Codes
| Code | ExceptionMessage | Cause |
|---|---|---|
000 | Success | Transaction records returned |
009 | No records found | No transactions exist in the requested date range, or transactions have not yet been processed |
103 | Member does not exist | RelationReference not found in the program |
203 | Member statement summary not available | Statement could not be retrieved |
204 | No transaction details available | No records match the query |
999 | Bad request | Missing or invalid date range / pagination fields |
Authorizations
JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.
Body
application/json
Response
200 - application/json
Statement summary