Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Rules

List Rules

This web service allows to list different rules at different levels i.e card, account, group and rule id.

post/pws/pws_list_rules/

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

modeinteger required
<p>Getting list based on mode value. mode can be</p><ul><li class="docBullet">1=token (token mandatory in this mode)</li><li class="docBullet">2=group_id (group_id mandatory in this mode)</li><li class="docBullet">3=ac_id (ac_id mandatory in this mode)</li><li class="docBullet">4=rule_id (rule_id mandatory in this mode)</li><li class="docBullet">5=token_group_id (token_group_id mandatory in this mode)</li><li class="docBullet">6=product_id (product_id mandatory in this mode)</li></ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

rule_idinteger

Rule Id. If you pass rule id , single rule will be retrieved. if mode==4, rule_id is mandatory

tokeninteger

public token for card. getting rule linked with specific token. if mode==1, token is mandatory

group_idinteger

group Id. rules under given group id. if mode==2 ,group_id is mandatory

ac_idinteger

account Id. Get All rules for Cards under linked to this Parent account. if mode==3, ac_id is mandatory

token_group_idinteger

token group Id. Rules under given token group id. if mode==5, token_group_id is mandatory

product_idinteger

product Id. Rules under given product id. if mode==6, product_id is mandatory

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "mode": 2,
  "rule_id": 366,
  "token": 311012081,
  "group_id": 1267,
  "ac_id": 479823917,
  "token_group_id": 21345,
  "product_id": 21345
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": [
    {
      "scope": "G",
      "rule_id": 153,
      "rule_desc": "Daily moto txn count",
      "rule_name": "Daily moto txn count",
      "max_value": 5000,
      "ac_id": 749153081,
      "token": 336869349,
      "rule_status": "enabled",
      "value": 500,
      "remaining_value": 50,
      "remaining_count": 50,
      "txn_limit_amount": 100,
      "max_count_value": 3,
      "rfc_params": [
        {
          "description": "No of Spends",
          "max": 20,
          "param_number": 1,
          "default_value": 10
        }
      ],
      "h_diff": 3600
    }
  ]
}