Get Rewards for User

Retrieves the complete rewards report for the authenticated business customer, including total accumulated points, last period reward details, and a grouped breakdown by reward type. This endpoint is available to business customers only, as rewards are a business-exclusive feature on the Netevia Banking platform. Use it to display reward balances, period summaries, and published report history within your application.

Endpoint

GET /api/UsersReward/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 a business customer wants to view their current rewards balance and transaction-level reward history. It is also useful for displaying period-over-period reward summaries or allowing customers to review rewards earned through card transactions, financial account activity, and transfers. Call this endpoint before initiating a rewards redemption to confirm available points.

Query Parameters

Response

200 OK

Top-level response object (usersrewardreports):

rewardreportresponse object (items in lastPeriodRewards):

rewardreportgrouped object (items in lastPeriodGrouped):

{
  "lastPeriodRewards": [
    {
      "profileId": 10042,
      "period": "2026-05-01T00:00:00Z",
      "dba": "Acme Corp",
      "transactionId": "txn_8a2f3c91d4e0",
      "totalCashBack": 250,
      "agentId": null,
      "type": 1,
      "comment": null,
      "percent": 1.5,
      "templateId": 3,
      "welcome": 0,
      "welcomeSpend": 0,
      "cashBack": 250,
      "cashBackExtr": 0,
      "cashBackExtrCredit": 0,
      "apr": 0,
      "aprSpend": 0,
      "manual": 0,
      "extraSpendCashBack": 0,
      "payment": 16667,
      "points": 2.50,
      "typeName": "Cash Back",
      "amount": 250,
      "fullName": "Jane Smith",
      "specialMerchant": 0
    }
  ],
  "totalPoints": 1840,
  "lastPeriodPublished": "2026-06-01T00:00:00Z",
  "publishedReports": [
    {
      "item1": "2026-05-01T00:00:00Z",
      "item2": 11
    },
    {
      "item1": "2026-04-01T00:00:00Z",
      "item2": 10
    }
  ],
  "lastPeriodPoints": 320,
  "lastPeriodGrouped": [
    {
      "type": 1,
      "points": 2.50,
      "typeName": "Cash Back",
      "amount": 250
    },
    {
      "type": 5,
      "points": 0.70,
      "typeName": "Special Merchant",
      "amount": 70
    }
  ]
}

Error Codes

Common Mistakes

• Calling this endpoint with a personal customer token — rewards are available to business customers only; a 403 will be returned.
• Passing a reportPeriodId from a period that has not yet been published; use the publishedReports array in the response to confirm valid period IDs before querying.
• Assuming totalPoints reflects only the last period — it is the cumulative lifetime total across all periods, not filtered by reportPeriodId.
• Interpreting monetary fields (e.g., totalCashBack, payment, amount) as dollars — these values are expressed in cents.

Related Endpoints

• POST /api/UsersReward/Redeem — Redeem accumulated reward points to a financial account
• GET /api/UsersReward/RewardsSummary — Get a high-level summary of reward balances
• GET /api/FinancialAccount/List — List financial accounts available as redemption targets

Example

curl -X GET "https://api.banking.netevia.dev/api/UsersReward/Rewards?reportPeriodId=11" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"