Download a detailed statement of reward activities for a selected period, including earnings, redemptions, and conversions.
Get Rewards Report
This endpoint enables business customers to download a detailed statement of their reward activities for a selected period. The statement includes reward points earned, redeemed, and exchanged for cash or other benefits. Customers can use this report to track and manage their rewards across a defined date range.
Endpoint
GET /api/UsersReward/v2/report
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint when a business customer needs a downloadable summary of their reward activity over a specific period. This is useful for reconciliation, auditing reward balances, or providing customers with a record of how points were earned and spent. The response contains file content that can be rendered or saved as a report document.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportPeriodId | integer (int32) | No | Identifier for the reporting period to retrieve the rewards statement for. Omit to retrieve the most recent available period. |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| name | string (nullable) | The filename of the generated report. |
| content | string (nullable) | The file content of the rewards report, typically base64-encoded or as a text payload. |
| contentType | string (nullable) | The MIME type of the report content (e.g., application/pdf, text/csv). |
{
"name": "rewards-report-2024-q1.pdf",
"content": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago...",
"contentType": "application/pdf"
}Error Codes
| Code | When it happens |
|---|---|
| 400 | Invalid or malformed reportPeriodId value provided |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions or caller is not a business customer |
| 404 | No rewards report found for the specified period |
| 500 | Internal server error |
Common Mistakes
- Passing a
reportPeriodIdthat does not exist or belongs to a different customer will result in a 404 response. - Rewards reports are only available for business customers; personal customer tokens will receive a 403 error.
- The
contentfield may be base64-encoded depending on thecontentType; ensure your client decodes it appropriately before rendering or saving.
Related Endpoints
GET /api/UsersReward/v2/balance— Retrieve the current rewards balance for the authenticated customerGET /api/UsersReward/v2/transactions— List individual reward transaction historyPOST /api/UsersReward/v2/redeem— Redeem reward points to a financial account
Example
curl -X GET "https://api.banking.netevia.dev/api/UsersReward/v2/report?reportPeriodId=3" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"