Type of banners

Get Reward Integration Type Enums

This endpoint returns an enumerated list of reward integration types supported by the Netevia platform. Each item includes a numeric identifier, a name, a human-readable description, and any associated group or endpoint metadata. Use this endpoint to populate dropdowns, validate input values, or understand which reward integration modes are available before configuring rewards-related functionality.

Endpoint

GET /api/enums/rewardIntegrationType

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

Call this endpoint when you need to determine the valid reward integration type values accepted by other rewards API endpoints. It is useful during initial integration to discover all supported types, and when building UI components that present reward integration options to partners or customers. Business customers earning or redeeming rewards through card transactions or financial account activity may be subject to a specific integration type.

Response

200 OK

Returns an array of enum description objects.

FieldTypeDescription
namestringThe canonical name of the reward integration type
idinteger (int32)Numeric identifier for the enum value
descriptionstringHuman-readable description of the reward integration type
groupNamestringOptional group classification for the enum value
endpointsarray of stringsList of API endpoints associated with this enum value
[
  {
    "id": 1,
    "name": "Standard",
    "description": "Standard reward integration for card transaction-based earning",
    "groupName": "RewardIntegration",
    "endpoints": ["/api/rewards/earn", "/api/rewards/redeem"]
  },
  {
    "id": 2,
    "name": "GiftCard",
    "description": "Reward integration type supporting gift card redemption",
    "groupName": "RewardIntegration",
    "endpoints": ["/api/rewards/giftcard"]
  }
]

Error Codes

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

Common Mistakes

  • Hardcoding reward integration type IDs in your integration instead of calling this endpoint to retrieve current values; enum IDs may change between API versions.
  • Ignoring the endpoints field, which indicates which API operations are valid for each integration type.

Related Endpoints

  • GET /api/enums/rewardType — Returns available reward type enum values
  • POST /api/rewards/earn — Records a reward earning event for a customer
  • POST /api/rewards/redeem — Redeems reward points for a business customer

Example

curl -X GET https://api.banking.netevia.dev/api/enums/rewardIntegrationType \
  -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