PApaymentology
Cashback

Activate Group Reward

Changed on

This web service allow us to apply reward at group level

post/pws/pws_reward_current_group_create/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_reward_current_group_create/
  • Auth
    none declared

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

effective_datestring required

Effective Date

expiration_datestring required

Expiration Date

group_idinteger required

group Id

max_cycle_rewardnumber required

Maximum reward amount that can be awarded per cycle; -1.00 mean 'Not Set'

max_daily_rewardnumber required

Maximum reward amount that can be awarded daily (calendar daily); -1.00 mean 'Not Set'

max_txn_rewardnumber required

Maximum reward amount that can be awarded per transaction; -1.00 mean 'Not Set'

reward_idinteger required

Reward Id

reward_rate_fixednumber required
<p>Fixed reward Rate in the account's Billing Currency.</br> Default:0.00</p>
reward_rate_logicstring required
<p>Relation between reward rates computed based on percentage and fixed amount.</br>The value can be one of them:</p><ul><li>SUM: Sum of them</li> <li> MIN: Minimum of two amounts</li> <li>MAX: Maximum of two amounts</li> <li>AVG: Average of two amounts</li></ul>
reward_rate_percnumber double required
<p>Reward Rate in Percents of the transaction </br>Default:0.00</p>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "effective_date": "2021-02-23 10:11:12",
  "expiration_date": "2022-02-23 10:11:12",
  "group_id": 5,
  "max_cycle_reward": 1,
  "max_daily_reward": 1,
  "max_txn_reward": 1,
  "reward_id": 5,
  "reward_rate_fixed": 1,
  "reward_rate_logic": "SUM",
  "reward_rate_perc": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Reward id 5 applied to group_id 1195 successfully"
  }
}

Changes