Get rewards for user

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

ParameterTypeRequiredDescription
dateFromstring (date-time)YesStart of the date range for filtering reward history. ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ.
dateTostring (date-time)YesEnd of the date range for filtering reward history. ISO 8601 format: YYYY-MM-DDTHH:mm:ssZ.
typesarray of integerNoFilter 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

ValueNameDisplay NameDescription
1CashBackSpending RewardsRewards earned from general spending.
2ExtraRewards for premium categoriesPremium category rewards.
3ExtraCreditSpending CreditCredit-related rewards for spending.
4RefundRefundRefund activity (hidden in some views).
5WelcomeWelcome BonusWelcome bonuses for new customers.
6WelcomeSpendingWelcome Spending BonusBonuses for spending shortly after joining.
7APREarned Credit RewardsEarned credit-based rewards.
8APRSpendingEarned Credit Spending RewardsRewards for spending based on financial account activity.
9ManualManual AdjustmentManual reward adjustments made by administrators.
10ExtraSpendCashBackSpending RewardsAdditional spending rewards.
11ExchangePointsExchange RewardsPoints exchanged for cash or other value.
12TransferTransfer OutPoints transferred out of the account.
13TransferInTransfer InPoints transferred into the account.
14GiftCardGift Card PurchasePurchase of gift cards using points.

Response

200 OK

Top-level Response Object (rewardhistoryresponse)

FieldTypeDescription
totalPointsinteger (int64)The customer's current total reward point balance.
publishedReportsarray of {item1, item2}List of published reward report entries. Each entry contains a date-time (item1) and an integer value (item2). Nullable.
historiesarray of reward point objectsOrdered 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)

FieldTypeDescription
createdDatestring (date-time)Timestamp when the reward record was created.
pointsinteger (int64)Number of points associated with this activity (positive for earned, negative for spent/transferred).
dateTransactionsstring (date-time)Timestamp of the underlying transaction that generated this reward event. Nullable.
typeinteger (int32)Reward history type value (see Reward Type Values table above).
subjectIdstringIdentifier of the subject entity linked to this reward event (e.g., transaction ID). Nullable.
periodstring (date-time)The reward period this entry belongs to.
amountinteger (int64)The transaction amount (in cents) associated with this reward activity.
typeNamestringHuman-readable display name of the reward type. Nullable.
subjectNamestringDisplay name of the subject entity linked to this reward event. Nullable.
publishDatestring (date-time)Date when the reward entry was published or finalized. Nullable.

Extended Transfer Fields (rewardpointsresponseextension — extends rewardpointsresponse)

FieldTypeDescription
userIdinteger (int64)Internal identifier of the user involved in the transfer event.
transferIdstringUnique 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

CodeWhen it happens
400dateFrom or dateTo is missing, malformed, or dateFrom is after dateTo; invalid types value provided
401Token missing, expired, or invalid
403Insufficient permissions; rewards history is only available for business customers
404No reward history found for the specified filters
500Internal server error

Common Mistakes

  • Omitting dateFrom or dateTo — both query parameters are required; the request will fail with 400 if either is absent.
  • Providing dateFrom in a format other than ISO 8601 date-time (e.g., 2025-06-01 instead of 2025-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 points for spending events — points are represented as positive for earned and negative for spent/transferred; check the type field to distinguish direction.

Related Endpoints

  • GET /api/UsersReward/v2 — Retrieve current reward point balance for the authenticated user
  • POST /api/UsersReward/v2/exchange — Exchange reward points for cash to a financial account
  • POST /api/UsersReward/v2/transfer — Transfer reward points to another business customer's account
  • POST /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"
Query Params
date-time
required
date-time
required
types
array of objects
types
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json