• Register

Get Plan Details By Id

Request Parameters:

Node Child Node Data Type Length 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_GET_PLAN_DETAILS_BYID" Mandatory
src_application String 10 Source requesting channel e.g. “IB” or "IVR" etc. Might change. Mandatory
target_application String 10 Target application name Ex. : "WAY4" or "DCMS" or "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 e.g. “XXXX” Mandatory
instance_id String 10 N/A Optional
body card_identifier_id String 32 454545XXXXXX1234 Mandatory 
card_identifier_type String 20 CONTRACT_NUMBER  or EXID Mandatory
instalment_id String 18 Instalment ID Mandatory

 Request JSON

{
  "NISrvRequest":{
    "request_get_plan_details_byid":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_GET_PLAN_DETAILS_BYID",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2022-11-16T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "card_identifier_id":"454545XXXXXX1234",
        "card_identifier_type":"CONTRACT_NUMBER/EXID",
		"instalment_id": 61992
		}
    }
  }
}

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 Function name to be used Default:  "REP_GET_PLAN_DETAILS_BYID" 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. “IB” or "IVR" etc
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
instance_id String 10 N/A Optional
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 instalment_id String 18 Instalment ID Mandatory
description String 255 Transaction description Optional
plan_number String 5 Plan Number Mandatory
creation_date String 10 Creation Date Mandatory
first_payment_date String 10 First Payment Date Mandatory
close_date String 10 Payment close Date Mandatory
currency String 3 Currency Mandatory
total_amount String 18 Total Amount Mandatory
principal String 18 Total instalment portfolio principal amount to pay Mandatory
fee String 18 Fee Mandatory
paid_amount String 18 Portion Paid amount Mandatory
due_amount String 18 Total instalment portfolio due amount  Mandatory
overdue_amount String 18 Total instalment portfolio overdue amount Mandatory
written_off_amount String 18 Written off Amount Mandatory
portion_total String 18 Total instalment portfolio Portion Mandatory
portion_principal String 18 Total instalment portfolio Portion Principal Mandatory
portion_fee String 18 Portion Fee Mandatory
portions number String 5  Number Mandatory
out_of String 5 Total Number of Installments Mandatory
open_date String 10 Open Date Mandatory
due_date String 10 Due Date Mandatory
currency String 3 Currency Mandatory
portion_amount String 18 Portion amount Mandatory
principal String 18 Principal Mandatory
fee String 18 Fee Mandatory
paid_amount String 18 Paid Amount Mandatory
Response JSON
{
  "NISrvResponse":{
    "response_get_plan_details_byid":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_GET_PLAN_DETAILS_BYID",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2022-11-16T11:06:36.588+04:00",
        "tracking_id":"56000",
        "bank_id":"bankID",
        "instance_id":"56000"
      },
      "exception_details":{
        "application_name":"TCC_ADP",
        "date_time":"2022-11-16T10:33:47.934+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
      },
      "body": {
        "instalment_id": 61992, 
		"description": "Test Script, step [Book BALCON (43203 Plan)]", 
		"plan_number": "43203", 
		"creation_date": "2022-03-01", 
		"first_payment_date": "2022-03-16",
		"close_date": "2023-03-05", 
		"currency":"AED",
		"total_amount":"1084.00", 
		"principal":"1000.00", 
		"fee":"84.00", 
		"paid_amount":"166.68", 
		"due_amount":"104.31", 
		"overdue_amount":"13.98", 
		"written_off_amount":"0.00", 
		"portion_total": "90.33",
		"portion_principal": "83.33", 
		"portion_fee": "7",   
		"portions": [
			{
			"number": "4", 
			"out_of": "10" 
			"open_date":"2022-06-16",
			"due_date":"2022-07-03", 
			"currency":"AED", 
			"portion_amount":"90.33", 
			"principal":"83.33", 
			"fee":"7", 
			"paid_amount":"0.00" 
			}
		]
      }
    }
  }
}

version 4 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation