POST loyalty/process-monthly

Request Information

URI Parameters

None.

Body Parameters

ProcessMonthlyRewardsRequest
NameDescriptionTypeAdditional information
Month

integer

Required

Range: inclusive between 1 and 12
Year

integer

Required

Range: inclusive between 2020 and 2100
CreditToAccounts

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Month": 1,
  "Year": 2,
  "CreditToAccounts": true
}

application/xml, text/xml

Sample: 
<ProcessMonthlyRewardsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <CreditToAccounts>true</CreditToAccounts>
  <Month>1</Month>
  <Year>2</Year>
</ProcessMonthlyRewardsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ProcessMonthlyRewardsRequest'.

Response Information

Resource Description

ProcessRewardsResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Message

string

None.
ProcessedUsers

integer

None.
TotalCashbackCredited

decimal number

None.
ProcessedSummaries

Collection of MonthlyCashbackSummary

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2",
  "ProcessedUsers": 3,
  "TotalCashbackCredited": 4.0,
  "ProcessedSummaries": [
    {
      "Id": 1,
      "DateCreated": "2026-03-26T03:52:04.2929687+02:00",
      "LastModified": "2026-03-26T03:52:04.2929687+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:52:04.2929687+02:00",
      "Credited": true,
      "DateCredited": "2026-03-26T03:52:04.2929687+02:00",
      "TransactionRef": "sample string 12",
      "RewardCount": 13,
      "UserName": "sample string 14",
      "MonthName": "sample string 15",
      "Period": "sample string 16"
    },
    {
      "Id": 1,
      "DateCreated": "2026-03-26T03:52:04.2929687+02:00",
      "LastModified": "2026-03-26T03:52:04.2929687+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:52:04.2929687+02:00",
      "Credited": true,
      "DateCredited": "2026-03-26T03:52:04.2929687+02:00",
      "TransactionRef": "sample string 12",
      "RewardCount": 13,
      "UserName": "sample string 14",
      "MonthName": "sample string 15",
      "Period": "sample string 16"
    }
  ]
}

application/xml, text/xml

Sample: 
<ProcessRewardsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Message>sample string 2</Message>
  <ProcessedSummaries>
    <MonthlyCashbackSummary>
      <AverageCashbackRate>9</AverageCashbackRate>
      <Credited>true</Credited>
      <DateCreated>2026-03-26T03:52:04.2929687+02:00</DateCreated>
      <DateCredited>2026-03-26T03:52:04.2929687+02:00</DateCredited>
      <DateProcessed>2026-03-26T03:52:04.2929687+02:00</DateProcessed>
      <Id>1</Id>
      <LastModified>2026-03-26T03:52:04.2929687+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>
    </MonthlyCashbackSummary>
    <MonthlyCashbackSummary>
      <AverageCashbackRate>9</AverageCashbackRate>
      <Credited>true</Credited>
      <DateCreated>2026-03-26T03:52:04.2929687+02:00</DateCreated>
      <DateCredited>2026-03-26T03:52:04.2929687+02:00</DateCredited>
      <DateProcessed>2026-03-26T03:52:04.2929687+02:00</DateProcessed>
      <Id>1</Id>
      <LastModified>2026-03-26T03:52:04.2929687+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>
    </MonthlyCashbackSummary>
  </ProcessedSummaries>
  <ProcessedUsers>3</ProcessedUsers>
  <Success>true</Success>
  <TotalCashbackCredited>4</TotalCashbackCredited>
</ProcessRewardsResponse>