• Register

Card Insurance Product

Card Insurance Product service is used by bank to fetch Insurance details of particular Account, below are the detailed specifications of this API.

Request Parameters:

Node Child Node Type Max Description Remarks
header msg_id A/N 12 Unique Source Message ID Mandatory
msg_type String 12 Request Type Default: "ENQUIRY" Mandatory
msg_function String 50 Function name to be used Default: "REQ_CARD_INSURANCE_PRODUCT" 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 card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory 
card_identifier_id
 String 32 454545XXXXXX1234 Mandatory 
Request Json
{
  "NISrvRequest":{
    "request_card_insurance_product":{
      "header":{
        "msg_id":"19530484",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_INSURANCE_PRODUCT",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"AJMN"
      },
      "body":{
        "card_identifier_id": "529016XXXXXX1383",
        "card_identifier_type": "CONTRACT_NUMBER/EXID"
      }
    }
  }
}

Response Parameters:

Node Child Node Data Max Description Remarks
header msg_id String 12 The msg_id sent in the request will be sent back in response in this field. Mandatory
Unique Source Message ID e.g. “ada123456fdsf”
msg_type String 12 msg_type sent in the request will be sent back in response in this field. Mandatory
msg_function String 50 Default: “REP_CARD_INSURANCE_PRODUCT” Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field. Mandatory
Source requesting channel e.g. “SSP”
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 Mandatory
Date & time. Format  “DD/MM/YYYY HH:MM:SS”
tracking_id String 15 The tracking_id sent in the request will be sent back in response in this field. Optional
bank_id String 4 The bank_id sent in the request will be sent back in response in this field. E.g. ‘ABCD Mandatory
Exception_details application_name String 20 Tibco Application Name Mandatory
date_time String 30 Timestamp of the response Mandatory
Format “DD/MM/YYYY HH:MM:SS”
status String 1 Status of the request (S/F) Mandatory
Success- S,  Failure - F
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
body card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory
card_identifier_id String 32 454545XXXXXX1234 Mandatory
insurance_products name String 255 Name of the insurance (E.g. Credit Shield) Mandatory
code String 2 Code of the insurance - From 01 to 12 Mandatory
is_active String 32 Business Reference of Status Mandatory
         
status_code String 10 Status Code of the insurance (F,R,U,etc.) Mandatory
status_name String 255 Status name (Enrolled, Cancelled by User, etc.) Mandatory
activation_date date  10 Activation date  
deactivation_date date  10 Deactivation date  
reinstatement_date date  10 Reinstatement date  
parameters
insurance_company String  255 insurance_company Mandatory
grace_period_duration String  3 grace_period_duration Mandatory
grace_period_type String  1 grace_period_type Mandatory
dlq_cancel_auto_reinstate String  2 dlq_cancel_auto_reinstate Mandatory
dlq_cancel_man_resinstate String  2 dlq_cancel_man_resinstate Mandatory
allow_zero_coverage String  1 allow_zero_coverage Mandatory
max_coverage_behavior String  1 max_coverage_behavior Mandatory
minimum_fee String  18 minimum_fee Mandatory
base_fee String  18 base_fee Mandatory
percentage String  3 percentage Mandatory
max_coverage String 18 max_coverage Mandatory
max_age String 3 max_age Mandatory

Json Response

{
    "NISrvResponse": {
        "response_card_insurance_product": {
            "header": {
                "msg_id": "19530484",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_CARD_INSURANCE_PRODUCT",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2023-02-24T13:23:45.514+04:00",
                "tracking_id": "236001",
                "bank_id": "AJMN"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-24T13:23:45.514+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            }
		"body":{
		  "card_identifier_id": "99985102164359586729",
		  "card_identifier_type": "EXID",
		  "insurance_products": 
			{
			  "name": "Credit Shield",
			  "code": "01",
			  "is_active": "CANCELLED",
			  "status_code": "R",
			  "status_name": "Canceled at the request of the insured party",
			  "parameters": {
				"insurance_company": "CS",
				"grace_period_duration": "1",
				"grace_period_type": "M",
				"dlq_cancel_auto_reinstate": "3",
				"dlq_cancel_man_reinstate": "4",
				"allow_zero_coverage": "N",
				"max_coverage_behavior": "A",
				"minimum_fee": "5",
				"base_fee": "0",
				"percentage": "1",
				"max_coverage": "7000",
				"max_age": "51"
			  }
			},
			{
			  "name": "Credit Shield Plus",
			  "code": "02",
			  "is_active": "CANCELLED",
			  "status_code": "U",
			  "status_name": "Canceled at the request of the underwriter",
			  "parameters": {
				"insurance_company": "CS",
				"grace_period_duration": "1",
				"grace_period_type": "M",
				"dlq_cancel_auto_reinstate": "3",
				"dlq_cancel_man_reinstate": "4",
				"allow_zero_coverage": "N",
				"max_coverage_behavior": "A",
				"minimum_fee": "5",
				"base_fee": "0",
				"percentage": "1",
				"max_coverage": "7000",
				"max_age": "51"
			  }
			}
		}
	}
  }
}


version 16 as of 1 year ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation