List of Reward history types

List of Reward History Types

The /api/enums/rewardHistoryTypes endpoint retrieves a comprehensive list of all reward history types that can be displayed in frontend applications. It returns various categories of rewards history entries, covering earned, redeemed, and adjusted reward events. This endpoint is useful for populating UI dropdowns, filters, and labels when presenting rewards activity to business customers.

Endpoint

GET /api/enums/rewardHistoryTypes

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 when building a rewards activity view or transaction history feature that needs to classify and label reward events by type. It provides the canonical list of reward history categories recognized by the Netevia platform, ensuring frontend labels stay in sync with backend data. This is particularly relevant for business customer portals where rewards earning, redemption, and adjustment history is displayed.

Response

200 OK

Returns an array of reward history type objects.

FieldTypeDescription
namestringShort name identifier for the reward history type
idinteger (int32)Numeric identifier for the reward history type
descriptionstringHuman-readable description of the reward history type
groupNamestringOptional grouping category the type belongs to
endpointsarray of stringList of API endpoints associated with this reward history type
[
  {
    "id": 1,
    "name": "EARNED",
    "description": "Rewards points earned through card transactions or account activity",
    "groupName": "Earning",
    "endpoints": ["/api/rewards/earn"]
  },
  {
    "id": 2,
    "name": "REDEEMED",
    "description": "Rewards points redeemed for cash transfer or gift cards",
    "groupName": "Redemption",
    "endpoints": ["/api/rewards/redeem"]
  },
  {
    "id": 3,
    "name": "ADJUSTED",
    "description": "Manual or system-initiated adjustment to rewards balance",
    "groupName": "Adjustment",
    "endpoints": []
  }
]

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions
500Internal server error

Common Mistakes

  • Calling this endpoint without a valid Bearer token will result in a 401 error even though it is a reference/enum endpoint.
  • Do not hardcode reward history type IDs in your application logic; always retrieve them from this endpoint to stay aligned with the platform's current enum values.
  • The endpoints field may be null or an empty array for some types — handle both cases in your client code.

Related Endpoints

  • GET /api/enums/rewardTypes — Retrieve the list of reward types (earning categories)
  • GET /api/rewards/history — Retrieve the rewards transaction history for a customer
  • POST /api/rewards/redeem — Redeem rewards points to a financial account or gift card

Example

curl -X GET https://api.banking.netevia.dev/api/enums/rewardHistoryTypes \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
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