Get Rewards History for User
This endpoint retrieves the full reward accrual history for the authenticated business customer. Results can be filtered by date range and one or more reward types, covering all 14 reward activity categories including spending rewards, welcome bonuses, point exchanges, transfers, and gift card purchases. The response also includes the customer's current total point balance and any published reward reports.
Endpoint
GET /api/UsersReward/v2/history
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint to display a customer's reward activity feed, reconcile earned and spent points, or generate reward statements within a partner application. It is suited for business customers who need a full audit trail of point activity including cash exchanges and inter-account transfers.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
dateFrom | string (date-time) | Yes | Start of the date range for filtering reward history. ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ. |
dateTo | string (date-time) | Yes | End of the date range for filtering reward history. ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ. |
types | array of integer | No | Filter results by one or more reward history types. Each value is an integer corresponding to a RewardHistoryType enum value (see table below). Omit to return all types. |
Reward Type Values
| Value | Name | Display Name | Description |
|---|---|---|---|
| 1 | CashBack | Spending Rewards | Rewards earned from general spending. |
| 2 | Extra | Rewards for premium categories | Premium category rewards. |
| 3 | ExtraCredit | Spending Credit | Credit-related rewards for spending. |
| 4 | Refund | Refund | Refund activity (hidden in some views). |
| 5 | Welcome | Welcome Bonus | Welcome bonuses for new customers. |
| 6 | WelcomeSpending | Welcome Spending Bonus | Bonuses for spending shortly after joining. |
| 7 | APR | Earned Credit Rewards | Earned credit-based rewards. |
| 8 | APRSpending | Earned Credit Spending Rewards | Rewards for spending based on financial account activity. |
| 9 | Manual | Manual Adjustment | Manual reward adjustments made by administrators. |
| 10 | ExtraSpendCashBack | Spending Rewards | Additional spending rewards. |
| 11 | ExchangePoints | Exchange Rewards | Points exchanged for cash or other value. |
| 12 | Transfer | Transfer Out | Points transferred out of the account. |
| 13 | TransferIn | Transfer In | Points transferred into the account. |
| 14 | GiftCard | Gift Card Purchase | Purchase of gift cards using points. |
Response
200 OK
Top-level Response Object (rewardhistoryresponse)
rewardhistoryresponse)| Field | Type | Description |
|---|---|---|
totalPoints | integer (int64) | The customer's current total reward point balance. |
publishedReports | array of {item1, item2} | List of published reward report entries. Each entry contains a date-time (item1) and an integer value (item2). Nullable. |
histories | array of reward point objects | Ordered list of reward history entries within the requested date range. Each entry is either a base rewardpointsresponse or an extended rewardpointsresponseextension (for transfer-type events). Nullable. |
Reward History Entry Fields (rewardpointsresponse)
rewardpointsresponse)| Field | Type | Description |
|---|---|---|
createdDate | string (date-time) | Timestamp when the reward record was created. |
points | integer (int64) | Number of points associated with this activity (positive for earned, negative for spent/transferred). |
dateTransactions | string (date-time) | Timestamp of the underlying transaction that generated this reward event. Nullable. |
type | integer (int32) | Reward history type value (see Reward Type Values table above). |
subjectId | string | Identifier of the subject entity linked to this reward event (e.g., transaction ID). Nullable. |
period | string (date-time) | The reward period this entry belongs to. |
amount | integer (int64) | The transaction amount (in cents) associated with this reward activity. |
typeName | string | Human-readable display name of the reward type. Nullable. |
subjectName | string | Display name of the subject entity linked to this reward event. Nullable. |
publishDate | string (date-time) | Date when the reward entry was published or finalized. Nullable. |
Extended Transfer Fields (rewardpointsresponseextension — extends rewardpointsresponse)
rewardpointsresponseextension — extends rewardpointsresponse)| Field | Type | Description |
|---|---|---|
userId | integer (int64) | Internal identifier of the user involved in the transfer event. |
transferId | string | Unique identifier of the associated transfer record. Nullable. |
{
"totalPoints": 14250,
"publishedReports": [
{
"item1": "2025-05-31T23:59:59Z",
"item2": 500
}
],
"histories": [
{
"createdDate": "2025-06-01T10:22:00Z",
"points": 120,
"dateTransactions": "2025-06-01T10:20:00Z",
"type": 1,
"subjectId": "txn_abc123",
"period": "2025-06-01T00:00:00Z",
"amount": 4000,
"typeName": "Spending Rewards",
"subjectName": "Purchase at Merchant XYZ",
"publishDate": "2025-06-02T00:00:00Z"
},
{
"createdDate": "2025-05-28T14:05:00Z",
"points": -500,
"dateTransactions": "2025-05-28T14:03:00Z",
"type": 12,
"subjectId": "txn_def456",
"period": "2025-05-01T00:00:00Z",
"amount": 0,
"typeName": "Transfer Out",
"subjectName": "Transfer to Partner Account",
"publishDate": "2025-05-28T00:00:00Z",
"userId": 789012,
"transferId": "xfer_ghi789"
}
]
}Error Codes
| Code | When it happens |
|---|---|
| 400 | dateFrom or dateTo is missing, malformed, or dateFrom is after dateTo; invalid types value provided |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions; rewards history is only available for business customers |
| 404 | No reward history found for the specified filters |
| 500 | Internal server error |
Common Mistakes
- Omitting
dateFromordateTo— both query parameters are required; the request will fail with 400 if either is absent. - Providing
dateFromin a format other than ISO 8601 date-time (e.g.,2025-06-01instead of2025-06-01T00:00:00Z) — use the full date-time format including time and timezone offset. - Passing an invalid integer for
types— only values 1 through 14 are valid; any other value will be rejected or silently ignored. - Calling this endpoint for personal customers — rewards are a business customer feature only; the call will return 403.
- Expecting negative
pointsfor spending events — points are represented as positive for earned and negative for spent/transferred; check thetypefield to distinguish direction.
Related Endpoints
GET /api/UsersReward/v2— Retrieve current reward point balance for the authenticated userPOST /api/UsersReward/v2/exchange— Exchange reward points for cash to a financial accountPOST /api/UsersReward/v2/transfer— Transfer reward points to another business customer's accountPOST /api/UsersReward/v2/giftcard— Redeem reward points for a gift card
Example
curl -X GET "https://api.banking.netevia.dev/api/UsersReward/v2/history?dateFrom=2025-05-01T00%3A00%3A00Z&dateTo=2025-06-01T23%3A59%3A59Z&types=1&types=11&types=12&types=13" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"