Notification Service

Send Notification API is be used to send an email or SMS or both to the cardholder.

Request Parameters:

Node	Child Node		Type	Length	Description	Remarks
header	msg_id		A/N	12	Unique Source Message ID	Mandatory
	msg_type		String	12	Request Type Default: "TRANSACTION"	Mandatory
	msg_function		String	50	Function name to be used Default: "REQ_SEND_NOTIFICATION"	Mandatory
	src_application		String	10	Source requesting channel Ex: IVR.	Mandatory
	target_application		String	10	Target application name Ex. : "PCMS"	Mandatory
	timestamp		String	30	Timestamp of the request Format “DD/MM/YYYY HH:MM:SS”	Mandatory
	tracking_id		String	15	Transaction Tracking Id	Optional
	bank_id		String	4	Source Bank Id Ex: bankID	Mandatory
body	identifier_id		String	32	454545XXXXXX1234	Optional
	identifier_type		String	20	CONTRACT_NUMBER or EXID	Optional
	email	to	String	32	For example: abc@email.com	Optional
		cc	String	32	For example: abc@email.com	Optional
		subject	String	20	Email Subject line	Optional
		body	String	255	Body of the email	Optional
		header	String	255	Any header to be added	Optional
		footer	String	255	Any footer to be added	Optional
	sms	mobile_number	String	32	Mobile Number Ex: 97155XXXXXXX	Optional
		text	String	255	SMS Details	Mandatory
		language_indicator	String	3	any of the value of ENG/ARA	Optional

Request Json

{
  "NISrvRequest": {
    "request_notification_service": {
      "header": {
        "msg_id": "236001",
        "msg_type": "TRANSACTION",
        "msg_function": "REQ_SEND_NOTIFICATION",
        "src_application": "IVR",
        "target_application": "WAY4",
        "timestamp": "2020-07-20T06:49:02.366Z",
        "bank_id": "NIC"
      },
      "body": {
        "identifier_id": "100000027",
        "identifier_type": "236001",
        "email": [
          {
            "to": "abc@email.com",
            "cc": "xyz@email.com",
            "subject": "SMS Notification Service",
            "body": "B",
            "header": "Header details",
            "footer": "footer details"
          }
        ],
        "sms": [
          {
            "text": "details ",
            "mobile_number": "97155XXXXXXX",
            "language_indicator": "ENG/ARA/E/A "
          }
        ]
      }
    }
  }
}

Response parameters:

Node	Child Node	Type	Max	Description	Remarks
header	msg_id	String	12	The msg_id sent in the request will be sent back in response in this field. Unique Source Message ID e.g. “adfasf123456”	Mandatory
	msg_type	String	12	Request Type	Mandatory
	msg_function	String	50	Function name to be used Default: "REP_SEND_NOTIFICATION"	Mandatory
	src_application	String	10	The src_application sent in the request will be sent back in response in this field.	Mandatory
	target_application	String	10	The target_application sent in the request will be sent back in response in this field.	Mandatory
	timestamp	String	30	Timestamp of the response Date & time. Format “DD/MM/YYYY HH:MM:SS”	Mandatory
	tracking_id	String	15	N/A	Optional
	bank_id	String	4	The bank_id sent in the request will be sent back in response in this field.	Mandatory
	instance_id	String	10	N/A	Optional
Exception_details	application_name	String	20	Application Name	Mandatory
	date_time	String	30	Timestamp of the response Format “DD/MM/YYYY HH:MM:SS”	Mandatory
	status	String	1	Status of the request (S/F) Success- S, Failure - F	Mandatory
	error_code	String	4	EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)	Mandatory
	error_description	String	100	Error Description (Check error codes section for the complete list of error codes and error code descriptions)	Mandatory
	transaction_ref_id	String	20	The tracking_id sent in the request will be sent back in response in this field.	Optional

Response JSON

{
  "NISrvResponse":{
    "response_notification_service":{
      "header":{
        "msg_id":"226001",
        "msg_type":"TRANSACTION",
        "msg_function":"REP_SEND_NOTIFICATION",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"19/07/2020 13:46:35",
        "tracking_id":"226001",
        "bank_id":"SSP"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2020-07-19T13:46:33.329+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":"1761831"
      }
    }
  }
}

version 20 as of 1 year ago by sumit ojha

0 Comments

Please sign in to post a comment.

Notification Service

0 Comments

Docs Navigation