GET loyalty/monthly-summary/{userId}/{month}/{year}

Request Information

URI Parameters

Name	Type	Additional information
userId	string	Required
month	integer	Required
year	integer	Required

Body Parameters

None.

Response Information

Resource Description

MonthlySummaryResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Summary	MonthlyCashbackSummary	None.
Rewards	Collection of LoyaltyReward	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "Summary": {
    "Id": 1,
    "DateCreated": "2026-03-26T03:50:48.1201953+02:00",
    "LastModified": "2026-03-26T03:50:48.1201953+02:00",
    "UserId": "sample string 4",
    "Month": 5,
    "Year": 6,
    "TotalDeposits": 7.0,
    "TotalCashback": 8.0,
    "AverageCashbackRate": 9.0,
    "Processed": true,
    "DateProcessed": "2026-03-26T03:50:48.1201953+02:00",
    "Credited": true,
    "DateCredited": "2026-03-26T03:50:48.1201953+02:00",
    "TransactionRef": "sample string 12",
    "RewardCount": 13,
    "UserName": "sample string 14",
    "MonthName": "sample string 15",
    "Period": "sample string 16"
  },
  "Rewards": [
    {
      "Id": 1,
      "DateCreated": "2026-03-26T03:50:48.1201953+02:00",
      "LastModified": "2026-03-26T03:50:48.1201953+02:00",
      "UserId": "sample string 4",
      "DepositAmount": 5.0,
      "CashbackPercentage": 6.0,
      "CashbackAmount": 7.0,
      "TransactionRef": "sample string 8",
      "FundingId": "sample string 9",
      "Month": 10,
      "Year": 11,
      "Credited": true,
      "DateCredited": "2026-03-26T03:50:48.1201953+02:00",
      "Status": "sample string 13",
      "RewardType": "sample string 14",
      "Description": "sample string 15",
      "UserName": "sample string 16",
      "MonthName": "sample string 17"
    },
    {
      "Id": 1,
      "DateCreated": "2026-03-26T03:50:48.1201953+02:00",
      "LastModified": "2026-03-26T03:50:48.1201953+02:00",
      "UserId": "sample string 4",
      "DepositAmount": 5.0,
      "CashbackPercentage": 6.0,
      "CashbackAmount": 7.0,
      "TransactionRef": "sample string 8",
      "FundingId": "sample string 9",
      "Month": 10,
      "Year": 11,
      "Credited": true,
      "DateCredited": "2026-03-26T03:50:48.1201953+02:00",
      "Status": "sample string 13",
      "RewardType": "sample string 14",
      "Description": "sample string 15",
      "UserName": "sample string 16",
      "MonthName": "sample string 17"
    }
  ]
}

application/xml, text/xml

Sample:

<MonthlySummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Message>sample string 2</Message>
  <Rewards>
    <LoyaltyReward>
      <CashbackAmount>7</CashbackAmount>
      <CashbackPercentage>6</CashbackPercentage>
      <Credited>true</Credited>
      <DateCreated>2026-03-26T03:50:48.1201953+02:00</DateCreated>
      <DateCredited>2026-03-26T03:50:48.1201953+02:00</DateCredited>
      <DepositAmount>5</DepositAmount>
      <Description>sample string 15</Description>
      <FundingId>sample string 9</FundingId>
      <Id>1</Id>
      <LastModified>2026-03-26T03:50:48.1201953+02:00</LastModified>
      <Month>10</Month>
      <MonthName>sample string 17</MonthName>
      <RewardType>sample string 14</RewardType>
      <Status>sample string 13</Status>
      <TransactionRef>sample string 8</TransactionRef>
      <UserId>sample string 4</UserId>
      <UserName>sample string 16</UserName>
      <Year>11</Year>
    </LoyaltyReward>
    <LoyaltyReward>
      <CashbackAmount>7</CashbackAmount>
      <CashbackPercentage>6</CashbackPercentage>
      <Credited>true</Credited>
      <DateCreated>2026-03-26T03:50:48.1201953+02:00</DateCreated>
      <DateCredited>2026-03-26T03:50:48.1201953+02:00</DateCredited>
      <DepositAmount>5</DepositAmount>
      <Description>sample string 15</Description>
      <FundingId>sample string 9</FundingId>
      <Id>1</Id>
      <LastModified>2026-03-26T03:50:48.1201953+02:00</LastModified>
      <Month>10</Month>
      <MonthName>sample string 17</MonthName>
      <RewardType>sample string 14</RewardType>
      <Status>sample string 13</Status>
      <TransactionRef>sample string 8</TransactionRef>
      <UserId>sample string 4</UserId>
      <UserName>sample string 16</UserName>
      <Year>11</Year>
    </LoyaltyReward>
  </Rewards>
  <Success>true</Success>
  <Summary>
    <AverageCashbackRate>9</AverageCashbackRate>
    <Credited>true</Credited>
    <DateCreated>2026-03-26T03:50:48.1201953+02:00</DateCreated>
    <DateCredited>2026-03-26T03:50:48.1201953+02:00</DateCredited>
    <DateProcessed>2026-03-26T03:50:48.1201953+02:00</DateProcessed>
    <Id>1</Id>
    <LastModified>2026-03-26T03:50:48.1201953+02:00</LastModified>
    <Month>5</Month>
    <MonthName>sample string 15</MonthName>
    <Period>sample string 16</Period>
    <Processed>true</Processed>
    <RewardCount>13</RewardCount>
    <TotalCashback>8</TotalCashback>
    <TotalDeposits>7</TotalDeposits>
    <TransactionRef>sample string 12</TransactionRef>
    <UserId>sample string 4</UserId>
    <UserName>sample string 14</UserName>
    <Year>6</Year>
  </Summary>
</MonthlySummaryResponse>