POST loyalty/calculate-cashback

Request Information

URI Parameters

None.

Body Parameters

CashbackCalculationRequest
NameDescriptionTypeAdditional information
UserId

string

Required

DepositAmount

decimal number

Required

Range: inclusive between 0,01 and 7,92281625142643E+28

TransactionRef

string

None.

FundingId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "DepositAmount": 2.0,
  "TransactionRef": "sample string 3",
  "FundingId": "sample string 4"
}

application/xml, text/xml

Sample:
<CashbackCalculationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <DepositAmount>2</DepositAmount>
  <FundingId>sample string 4</FundingId>
  <TransactionRef>sample string 3</TransactionRef>
  <UserId>sample string 1</UserId>
</CashbackCalculationRequest>

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 'CashbackCalculationRequest'.

Response Information

Resource Description

CashbackCalculationResponse
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

DepositAmount

decimal number

None.

CashbackPercentage

decimal number

None.

CashbackAmount

decimal number

None.

TransactionReference

string

None.

DateCalculated

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "DepositAmount": 3.0,
  "CashbackPercentage": 4.0,
  "CashbackAmount": 5.0,
  "TransactionReference": "sample string 6",
  "DateCalculated": "2026-03-26T03:51:41.6250243+02:00"
}

application/xml, text/xml

Sample:
<CashbackCalculationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <CashbackAmount>5</CashbackAmount>
  <CashbackPercentage>4</CashbackPercentage>
  <DateCalculated>2026-03-26T03:51:41.6250243+02:00</DateCalculated>
  <DepositAmount>3</DepositAmount>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <TransactionReference>sample string 6</TransactionReference>
</CashbackCalculationResponse>