PApaymentology
Rules V2

Create Financial Rules

Changed on

Version 2 Financial Rules api support idempotency

This web service allows to set Limits for restricting ATM and ECOM transactions like :

  • Daily ATM Cash Limit
  • Weekly ATM Cash Limit
  • Monthly ATM Cash Limit
  • Yearly ATM Cash Limit
  • Daily ECOM Limit
  • Weekly ECOM Limit
  • Monthly ECOM Limit
  • Yearly ECOM Limit
  • Daily ATM Txn Count
  • Daily POS Txn Count
  • Daily ECOM Txn Count
  • Daily MOTO Txn Count
post/pws/v2/pws_financial_rules/

Request

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

limit_typeinteger required
<p>Limit type can be:</p> <ul> <li class="docBullet">1-Daily ATM Cash Limit</li> <li class="docBullet">2-Weekly ATM Cash Limit</li> <li class="docBullet">3-Monthly ATM Cash Limit</li> <li class="docBullet">4-Yearly ATM Cash Limit</li> <li class="docBullet">5-Daily ECOM Limit</li> <li class="docBullet">6-Weekly ECOM Limit</li> <li class="docBullet">7-Monthly ECOM Limit</li> <li class="docBullet">8-Yearly ECOM Limit</li> <li class="docBullet">9-Daily ATM Txn Count</li> <li class="docBullet">10-Daily POS Txn Count</li> <li class="docBullet">11-Daily ECOM Txn Count</li> <li class="docBullet">12-Daily MOTO Txn Count</li> <li class="docBullet">13-Weekly ATM Txn Count</li> <li class="docBullet">14-Weekly ATM POS Count</li> <li class="docBullet">15-Weekly ECOM Txn Count</li> <li class="docBullet">16-Weekly MOTO Txn Count</li> <li class="docBullet">17-Monthly ATM Txn Count</li> <li class="docBullet">18-Monthly POS Txn Count</li> <li class="docBullet">19-Monthly ECOM Txn Count</li> <li class="docBullet">20-Monthly MOTO Txn Count</li> <li class="docBullet">21-Yearly ATM Txn Count</li> <li class="docBullet">22-Yearly POS Txn Count</li> <li class="docBullet">23-Yearly ECOM Txn Count</li> <li class="docBullet">24-Yearly MOTO Txn Count</li> <li class="docBullet">25-Daily POS Limit</li> <li class="docBullet">26-Weekly POS Limit</li> <li class="docBullet">27-Monthly POS Limit</li> <li class="docBullet">28-Yearly POS Limit</li> <li class="docBullet">29-Daily MOTO Limit</li> <li class="docBullet">30-Weekly MOTO Limit</li> <li class="docBullet">31-Monthly MOTO Limit</li> <li class="docBullet">32-Yearly MOTO Limit</li> <li class="docBullet">33-LifeTime Card Limit(ATM+POS) transactions</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=Account rules (These rules are more generic to card program which is set at account level and typically used to set upper limit controls.)</li><li class="docBullet">P=Product rules (These rules are set to the product.)</li></ul>

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

amount_limitnumber

Amount limit for daily /weekly /monthly /yearly cash limit

txn_amount_limitnumber

Per transaction amount limit

group_idinteger

Group Id Required when scope = G or T

tokeninteger

Public token of card. Required when scope=C

account_idinteger

Parent account of a card. Required when scope=A

product_idinteger

Product Id. Required when scope=P

txn_countinteger

Number of transaction allowed for daily /weekly /monthly /yearly transaction.

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>

network_supportedstring
<p>Bit vector to determine the networks supported:</p><p>0 =&gt; unset</p><p>1 =&gt; set</p> <p>Example : selected network Mastercard and VISA&nbsp;, <em>network_supported</em> value : <em>1100000000</em></p><table border="1" cellspacing="1" cellpadding="1"><tbody><tr><th style="text-align: center;" colspan="2"><strong>Bit Vector to determine the networks supported</strong></th></tr><tr><td style="text-align: center;">Bit position</td><td style="text-align: center;">Network</td></tr><tr><td style="text-align: center;">0</td><td style="text-align: center;">MasterCard</td></tr><tr><td style="text-align: center;">1</td><td style="text-align: center;">VISA</td></tr><tr><td style="text-align: center;">2</td><td style="text-align: center;">AFS</td></tr><tr><td style="text-align: center;">3</td><td style="text-align: center;">UPI</td></tr><tr><td style="text-align: center;">4</td><td style="text-align: center;">CR2</td></tr><tr><td style="text-align: center;">5</td><td style="text-align: center;">JTCO</td></tr><tr><td style="text-align: center;">6</td><td style="text-align: center;">PROSA</td></tr><tr><td style="text-align: center;">7</td><td style="text-align: center;">UAE</td></tr><tr><td style="text-align: center;">8</td><td style="text-align: center;">MADA</td></tr><tr><td style="text-align: center;">9</td><td style="text-align: center;">CRTX</td></tr></tbody></table>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "limit_type": 1,
  "scope": "G",
  "amount_limit": 1000,
  "txn_amount_limit": 500,
  "group_id": 1267,
  "token": 311012081,
  "account_id": 513124,
  "product_id": 1423,
  "txn_count": 500,
  "action_decline": "61",
  "network_supported": "0101010101"
}

Response

Successful Response

Example response

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

Changes