Get Rewards Template for User

The Get Rewards Template endpoint returns the main conditions under which rewards are accrued to a customer. It provides a complete overview of the reward criteria and guidelines applicable to the customer's earned rewards, including spending thresholds, percentage rates, welcome bonuses, APR-based rewards, and category-specific extra spend rules.

Endpoint

GET /api/UsersReward/template

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 to display a customer's reward program conditions within your application, helping them understand how their rewards are calculated. This is typically called when a customer views their rewards summary or dashboard to review earning criteria such as spend minimums, bonus categories, and welcome offer details. Partners can also use it to surface reward template information for customer support or onboarding flows.

Response

200 OK

The response returns a rewardtemplate object. Fields inherited from the base entity (id, createdDate, updatedDate) are included alongside template-specific fields.

extraSpendRewards array items

Each item in extraSpendRewards describes a merchant-category-specific bonus rule:

merchantCategories array items

{
  "id": 12,
  "createdDate": "2024-01-15T08:00:00Z",
  "updatedDate": "2024-06-01T10:30:00Z",
  "name": "Business Rewards Standard",
  "expiredDate": null,
  "isActive": true,
  "isExceptional": false,
  "isForNew": false,
  "isDefault": true,
  "rewardType": 1,
  "rulesMin": 50000,
  "debitSpendPercent": 1.5,
  "extraDebitSpendPercent": 2.0,
  "extraSpendAmount": 500,
  "welcomePercent": 5.0,
  "welcomeTimeDays": 90,
  "welcomeMin": 10000,
  "welcomeSpendAmount": 20000,
  "welcomeSpendMin": 100000,
  "welcomeSpendTimeDays": 60,
  "aprPercent": 0.5,
  "extraAPRPercent": 1.0,
  "extraAPRAmount": 1000,
  "aprSpendMin": 25000,
  "extraSpendRewards": [
    {
      "id": 5,
      "createdDate": "2024-01-15T08:00:00Z",
      "updatedDate": null,
      "rewardTemplateId": 12,
      "percent": 3.0,
      "merchantName": null,
      "fullSearch": false,
      "allCategory": false,
      "debitSpendMin": 5000,
      "period": 1,
      "type": 1,
      "merchantCategories": [
        {
          "id": 21,
          "extraSpendRewardId": 5,
          "merchantCategory": "GROCERY_STORES_SUPERMARKETS"
        },
        {
          "id": 22,
          "extraSpendRewardId": 5,
          "merchantCategory": "FAST_FOOD_RESTAURANTS"
        }
      ]
    }
  ],
  "isDeleted": false,
  "isConsumer": false
}

Error Codes

Common Mistakes

• Monetary fields such as rulesMin, debitSpendMin, welcomeMin, welcomeSpendMin, aprSpendMin, extraAPRAmount, and welcomeSpendAmount are expressed in cents — divide by 100 to display dollar amounts.
• A null value for extraSpendRewards means no category-specific bonus rules are configured; treat it as an empty list rather than an error.
• The rewardType enum uses values 1, 2, and 4 — there is no value 3. Map these explicitly rather than treating them as sequential.
• The period enum for extra spend rewards uses 1 for monthly and 2 for annually — do not assume 0-based indexing.
• isConsumer: false indicates a business rewards template. Personal customer templates will have isConsumer: true and may have different fields populated.

Related Endpoints

• GET /api/UsersReward — Retrieve the current reward balance and accrual history for the authenticated customer
• POST /api/UsersReward/redeem — Redeem accrued rewards to a financial account or another Netevia business customer's account

Example

curl -X GET https://api.banking.netevia.dev/api/UsersReward/template \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"