Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Rules action

Create Alert action

This API is used to create alert action that can be applied to different rule.

post/pws/pws_action_alert/

Request body

action_namestring required
<p>This is just a name given to alert action</p></br>Eg.Decline for decline action.</br>Alert for Alert action
api_call_unique_identifierstring required

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

bodystring required

,message container

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

rule_idinteger required

Id of rule in which we want to add decline action.Rule Id is returned when creating rule.

substring required

Subject

tostring required
<p>Recepient :Value of to can be :</p> <ul> <li class="docBullet" >me</li> <li class="docBullet" >cardholder</li> <li class="docBullet" >parent_account_owner</li> <li class="docBullet" >cust_service_1</li> <li class="docBullet" >aml_team</li> <li class="docBullet" >custom</li> </ul>
typestring required
<p>action Type Values of type can be :"1" or "2" or "1,2".</p> <ul> <li class="docBullet" >"1"-–indicate sending alert through sms</li> <li class="docBullet" >"2" --indicates sending alert through email</li> <li class="docBullet" >"1,2" --indicates sending alert through both email and sms</li><ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

phonestring
<p>Phone Number mandatory when type is one of the following:</p> <ul> <li>type=="1"</li> <li>type="1,2"</li> </ul>
emailstring
<p>Email Id mandatory when type is one of the following:</p> <ul> <li>type=="2"</li> <li>type=="1,2"</li> </ul>

Example request

{
  "action_name": "alert",
  "api_call_unique_identifier": "438574845790657485",
  "body": "test message",
  "client_id": 760131,
  "rule_id": 366,
  "sub": "sub",
  "to": "me",
  "type": "2",
  "phone": "9845665455",
  "email": "Test@paymentology.com"
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "id": 1853
  }
}