Total Rewards Points Converted
This endpoint retrieves an aggregate summary of rewards points activity, including total points converted into dollars, points earned since program inception, and monthly conversion metrics. It is designed for partner dashboards and reporting tools that need a high-level view of rewards program performance. The response covers both cumulative totals and last-month figures to support trend analysis.
Endpoint
GET /api/Widget/Rewards
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 partner dashboards or administrative widgets that display rewards program performance metrics. It is useful for monitoring how actively customers are redeeming rewards points and understanding the monetary impact of the rewards program over time. This endpoint is typically called by partners who want to surface high-level conversion statistics without querying individual customer records.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| isoId | integer (int32) | No | Filter results by ISO (Independent Sales Organization) identifier. |
| agentId | integer (int32) | No | Filter results by agent identifier. |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| totalRewards | integer (int32) | Total number of rewards points currently outstanding across all customer profiles. |
| totalFromStart | integer (int32) | Total number of rewards points earned since the program started. |
| rewardsLastMonth | integer (int32) | Number of rewards points earned during the previous calendar month. |
| totalConverted | integer (int64) | Cumulative total of rewards points that have been converted into dollar value. |
| convertedLastMonth | integer (int64) | Number of rewards points converted into dollar value during the previous calendar month. |
{
"totalRewards": 150000,
"totalFromStart": 2500000,
"rewardsLastMonth": 18500,
"totalConverted": 1200000,
"convertedLastMonth": 9200
}Error Codes
| Code | When it happens |
|---|---|
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to access widget data |
| 500 | Internal server error |
Common Mistakes
- Omitting the
Authorization: Bearerheader results in a 401 response; ensure the token has been obtained and has not expired (10-minute lifetime). - Passing non-integer values for
isoIdoragentIdwill result in a 400 or ignored parameter — always send whole numbers. - The
totalConvertedandconvertedLastMonthfields areint64; deserialize them accordingly to avoid overflow in languages with strict 32-bit integer types.
Related Endpoints
GET /api/Widget/Customers— retrieve aggregate customer count metrics for the partner dashboardGET /api/Widget/Transactions— retrieve aggregate transaction volume metricsPOST /api/auth/v2— obtain a Bearer token required for all authenticated requests
Example
curl -X GET "https://api.banking.netevia.dev/api/Widget/Rewards?isoId=101&agentId=55" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"