PApaymentology
Rules V2

Create Rules Advanced

Changed on

This web service allows to create different types of advanced rules.<p>Version 2 Advanced Rules api support idempotency</p>

post/pws/v2/pws_other_rules/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/v2/pws_other_rules/
  • 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

parametersstring required

Parameters for rules.<ul><li class="docBullet">format of parameter is TAG:VALUE </li><li class="docBullet">parameter can be combination of multiple TAG:VALUE separated by semicolon(;) </li><li class="docBullet">VALUE can contain comma(,) separated multiple values </li><li class="docBullet">Accepted TAGS are MCC,TXN_CCY,CTRY</li><li class="docBullet">TXN_CCY=> transaction Currency DE49. (Three digit Numeric ISO-4217 standard currency code . i.e. : 048 → BHD, 060 → BMD, 036 → AUD)</li> <li class="docBullet">MCC=> Merchant category code DE18.</li><li class="docBullet">CTRY=> Country (DE43_5). <ul><li>For Master card (Alpha Three country ISO codes. i.e. : Afghanistan → AFG, Australia → AUS) </li><li>For VISA (Alpha Two country ISO codes . i.e. : Afghanistan → AF, Australia → AU) </li><li>For Both (MC & VISA) :(Comma separated Alpha Three country ISO codes & Alpha Two country ISO codes i.e Afghanistan-> AFG,AF , Australia → AUS,AU )</li> </ul> </li></ul>

rule_descstring required

Rule description. Description should specific and should describe rule in a concise manner.

rule_namestring required

Rule name

rule_typestring required

Rule Type : <ul><li class="docBullet">Au = Authorisation</li><li class="docBullet">Se = Settlement</li><li class="docBullet">Sc = Scheduled</li><li class="docBullet">Lo = Load</li><li class="docBullet">Un = Unload</li><li class="docBullet">Ot = Others</li><li class="docBullet">Da = Deactivated</li></ul>

scopestring required

Rule applicable scope. Values of scope can be : <ul><li class="docBullet">C=Direct card rules (These rules are held at individual card level and therefore can be personalized per card holder.)</li><li class="docBullet">G=Group rules (These rules are more generic to card program and typically used to set upper limit controls.)</li><li class="docBullet">T=Token Group rules (These rules are more generic to card program which is set at token level and typically used to set upper limit controls.)</li><li class="docBullet">A=Parent Account rules (These rules cascade down to the cards linked to all children accounts of this parent.)</li><li class="docBullet">P=Product rules (These rules are set to the product.)</li></ul>

severityinteger required

Severity evel. It can be 0(lowest)-10(highest)

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

tokeninteger

Public token for card. Required in case of scope 'C'

group_idinteger

Group Id. Required in case of scope 'G' or 'T'

suitable_for_estimateboolean
<ul><li class="docBullet">True = Rule is for limit check like (amount limit or transaction count limit)</li><li class="docBullet">False =Rule is not for limit check like (amount limit or transaction count limit)</li></ul>
action_declinestring

Decline action,de39 response code <ul> <li class="docBullet">57 = Txn not permitted</li> <li class="docBullet">03 = Invalid merchant</li> <li class="docBullet">04 = Capture card</li> <li class="docBullet">05 = Do not honour</li> <li class="docBullet">12 = Invalid txn</li> <li class="docBullet">13 = Invalid amt</li> <li class="docBullet">14 = Invalid card no</li> <li class="docBullet">30 = Format Error</li> <li class="docBullet">41 = Lost card</li> <li class="docBullet">43 = Stolen card</li> <li class="docBullet">51 = Insufficient Funds</li> <li class="docBullet">54 = Expired card</li> <li class="docBullet">55 = Invalid pin</li> <li class="docBullet">57 = Txn not allowed</li> <li class="docBullet">58 = Invalid txn/terminal</li> <li class="docBullet">61 = Exceed Cash Limit</li> <li class="docBullet">62 = Restricted card</li> <li class="docBullet">63 = Security violation</li> <li class="docBullet">71 = pin not changed</li> <li class="docBullet">75 = Pin tries exceeded</li> <li class="docBullet">88 = crypto Fail</li> <li class="docBullet">96 = System error</li> <li class="docBullet">70 = Contact card issuer</li> </ul>

account_idinteger

Account Id. Required in case of scope 'A'

product_idinteger

Product Id. Required in case of scope 'P'

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "parameters": "MCC:6011,4444,1234,5543;TXN_CCY:826,400;CTRY:GBR,USA",
  "rule_desc": "Fraud Rule Description",
  "rule_name": "Fraud Rule",
  "rule_type": "Au",
  "scope": "G",
  "token": 311012081,
  "group_id": 1267,
  "action_decline": "05",
  "account_id": 12671234,
  "product_id": 1326
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "rule_id": 103
  }
}

Changes