List of Insurance Program

This service is used for fetching the details about insurance program for a particular contract.

Code example

Click on the buttons to view code snippet:

curl -X GET \
  https://apitest.network.ae/cards/:card_identifier_id/insurances/:code?card_identifier_type=nisi non \
  -H 'authorization: Bearer tzhhqun37x69bspsbfbz9ek9' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'Unique-Reference-Code: nisi non' \
  -H 'Financial-Id: nisi non' \
  -H 'Channel-Id: nisi non' \


import requests

url = "https://apitest.network.ae/cards/:card_identifier_id/insurances?card_identify_type=nisi non"

payload={}
headers = {
  'Unique-Reference-Code': 'nisi non',
  'Financial-Id': 'nisi non',
  'Channel-Id': 'nisi non',
  'Accept': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)


setUrl('https://apitest.network.ae/cards/:card_identifier_id/insurances?card_identify_type=nisi non');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Unique-Reference-Code' => 'nisi non',
  'Financial-Id' => 'nisi non',
  'Channel-Id' => 'nisi non',
  'Accept' => 'application/json'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://apitest.network.ae/cards/:card_identifier_id/insurances?card_identify_type=nisi non")
  .method("GET", body)
  .addHeader("Unique-Reference-Code", "nisi non")
  .addHeader("Financial-Id", "nisi non")
  .addHeader("Channel-Id", "nisi non")
  .addHeader("Accept", "application/json")
  .build();
Response response = client.newCall(request).execute();

Request Parameters:

HTTP	Key	Type	Max	Description	Remarks
header	Unique-Reference-Code	A/N	12	Unique Reference Code for identification of each request sent to API	Mandatory
	Channel-Id	String	10	Requesting channel e.g. “IB” or "IVR" etc. Might change.	Mandatory
	Financial-Id	String	4	Source Bank Id e.g. “NIC”	Mandatory
path	card_identifier_id	String	Min – 16 Max - 19	Unique Identifier for Card	Mandatory
query	card_identify_type	String	15	Identifier Type for Card (default EXID)	Optional

Response Parameters:

HTTP	Key			Type	Max	Description	Remarks
body	card_identifier_id			String	20	CONTRACT_NUMBER or EXID	Mandatory
	card_identifier_type			String	32		Mandatory
	Array of insurance_products
	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		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
		parameters	insurance_company	String	32	Insurance Company	Mandatory
			grace_period_duration	String	32	grace_period_duration	Mandatory
			grace_period_type	String	32	grace_period_type	Mandatory
			dlq_cancel_auto_reinstate	String	32	dlq_cancel_auto_reinstate	Mandatory
			dlq_cancel_man_reinstate	String	32	dlq_cancel_man_reinstate	Mandatory
			allow_zero_coverage	String	32	allow_zero_coverage	Mandatory
			max_coverage_behavior	String	32	max_coverage_behavior	Mandatory
			minimum_fee	String	32	minimum_fee	Mandatory
			base_fee	String	32	base_fee	Mandatory
			percentage	String	32	percentage	Mandatory
			max_coverage	String	32	max_coverage	Mandatory
			max_age	String	32	max_age	Mandatory

Response Json

{
  "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"
      }
    },
    {
      "name": "User Insurance 3",
      "code": "03",
      "is_active": "CANCELLED",
      "status_code": "R",
      "status_name": "Canceled at the request of the insured party",
      "parameters": {
        "insurance_company": "IC",
        "grace_period_duration": "1",
        "grace_period_type": "M",
        "dlq_cancel_auto_reinstate": "4",
        "dlq_cancel_man_reinstate": "5",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "A",
        "minimum_fee": "5",
        "base_fee": "0",
        "percentage": "1",
        "max_coverage": "0",
        "max_age": "51"
      }
    },
    {
      "name": "User Insurance 5",
      "code": "05",
      "is_active": "ACTIVE",
      "status_code": "F",
      "status_name": "In force",
      "parameters": {
        "insurance_company": "IC",
        "grace_period_duration": "1",
        "grace_period_type": "M",
        "dlq_cancel_auto_reinstate": "3",
        "dlq_cancel_man_reinstate": "",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "M",
        "minimum_fee": "0",
        "base_fee": "23",
        "percentage": "0",
        "max_coverage": "7000",
        "max_age": "51"
      }
    },
    {
      "name": "Travel Insurance",
      "code": "06",
      "is_active": "ACTIVE",
      "status_code": "F",
      "status_name": "In force",
      "parameters": {
        "insurance_company": "TA",
        "grace_period_duration": "1",
        "grace_period_type": "M",
        "dlq_cancel_auto_reinstate": "3",
        "dlq_cancel_man_reinstate": "",
        "allow_zero_coverage": "Y",
        "max_coverage_behavior": "M",
        "minimum_fee": "0",
        "base_fee": "23",
        "percentage": "0",
        "max_coverage": "0",
        "max_age": "51"
      }
    },
    {
      "name": "User Insurance 7",
      "code": "07",
      "is_active": "ACTIVE",
      "status_code": "F",
      "status_name": "In force",
      "parameters": {
        "insurance_company": "IC",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "",
        "dlq_cancel_man_reinstate": "4",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "",
        "minimum_fee": "10",
        "base_fee": "0",
        "percentage": "2",
        "max_coverage": "7000",
        "max_age": "51"
      }
    },
    {
      "name": "User Insurance 8",
      "code": "08",
      "is_active": "CANCELLED",
      "status_code": "R",
      "status_name": "Canceled at the request of the insured party",
      "parameters": {
        "insurance_company": "IC",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "",
        "dlq_cancel_man_reinstate": "4",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "",
        "minimum_fee": "10",
        "base_fee": "0",
        "percentage": "2",
        "max_coverage": "7000",
        "max_age": "51"
      }
    },
    {
      "name": "User Insurance 9",
      "code": "09",
      "is_active": "ACTIVE",
      "status_code": "F",
      "status_name": "In force",
      "parameters": {
        "insurance_company": "IC",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "3",
        "dlq_cancel_man_reinstate": "3",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "",
        "minimum_fee": "10",
        "base_fee": "0",
        "percentage": "2",
        "max_coverage": "0",
        "max_age": "51"
      }
    },
    {
      "name": "Accident Insurance",
      "code": "10",
      "is_active": "CANCELLED",
      "status_code": "R",
      "status_name": "Canceled at the request of the insured party",
      "parameters": {
        "insurance_company": "TA",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "3",
        "dlq_cancel_man_reinstate": "3",
        "allow_zero_coverage": "Y",
        "max_coverage_behavior": "",
        "minimum_fee": "10",
        "base_fee": "0",
        "percentage": "2",
        "max_coverage": "7000",
        "max_age": "51"
      }
    },
    {
      "name": "Purchase Insurance",
      "code": "11",
      "is_active": "ACTIVE",
      "status_code": "F",
      "status_name": "In force",
      "parameters": {
        "insurance_company": "TA",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "",
        "dlq_cancel_man_reinstate": "",
        "allow_zero_coverage": "N",
        "max_coverage_behavior": "",
        "minimum_fee": "0",
        "base_fee": "34",
        "percentage": "0",
        "max_coverage": "7000",
        "max_age": "51"
      }
    },
    {
      "name": "Travel Insurance Plus",
      "code": "12",
      "is_active": "CANCELLED",
      "status_code": "U",
      "status_name": "Canceled at the request of the underwriter",
      "parameters": {
        "insurance_company": "TA",
        "grace_period_duration": "2",
        "grace_period_type": "B",
        "dlq_cancel_auto_reinstate": "",
        "dlq_cancel_man_reinstate": "",
        "allow_zero_coverage": "Y",
        "max_coverage_behavior": "",
        "minimum_fee": "0",
        "base_fee": "34",
        "percentage": "0",
        "max_coverage": "0",
        "max_age": "51"
      }
    }
  ]
}

version 13 as of 3 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

List of Insurance Program

Code example

0 Comments

Docs Navigation