• Register

Refinance Transaction

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_REFINANCE_TRANSACTION" 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
trans_id String 20 Transaction ID Mandatory
plan_number String 5 Plan number for conversion configured by the bank. Mandatory
instalment_description String 255 IPP Plan Description Optional
channel String 12 Channel Optional
Array Of Options
options key String 20 key Optional
value String 128 value
override_options waive_fee String 1 Processing Fee Waiver Optional
ad-hoc_fee_type String 1 Ad-hoc Fee type: P - percentage, F - fixed Optional
ad-hoc_fee String 18 Ad-hoc Fee value: the number will be treated as percentage or amount, depending on the AH_FEE_TYPE Optional
interest_rate String 3 Instalment fee rate Optional
portion_amount String 18 Desired maximum amount on the portion Optional
number_of_portions String 4 Number of portions Optional
grace_period String 3 Number of cycles to shift before billing the first portion. Optional
free_period_number String 3 Number of portions to apply zero fee rate to. The period starts with the first portion. Optional
Request Json
{
  "NISrvRequest":{
    "request_refinance_transaction":{
      "header":{
        "msg_id":"236001",
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_REFINANCE_TRANSACTION",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2022-11-16T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"NIC"
      },
      "body":{
        "card_identifier_id":"454545XXXXXX1234",
        "card_identifier_type":"CONTRACT_NUMBER/EXID",
		"trans_id": "92572",
        "plan_number": "41412",
        "instalment_description": "IPP Booking from API",
        "channel": "IVR",
		"options": [
        {
            "key": "BOOK_TYPE",
            "value": "TR01"
        },
        {
            "key": "PB_WF",
            "value": "CT_TIB"
        }
    ],
        "override_options": {
			"waive_fee": "Y",
			"ad-hoc_fee_type": "F",
			"ad-hoc_fee": "25.56",
			"interest_rate": "15.45",
			"portion_amount": "50000.0",
			"number_of_portions":""
			"grace_period": "1",
			"free_period_number": "1"
		}	
      }
    }
  }
}

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.
Unique Source Message ID e.g. “ada123456fdsf”
Mandatory
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_REFINANCE_TRANSACTION" Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field.
Source requesting channel e.g. “IB” or "IVR" etc
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 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
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_refinance_transaction":{
         "header":{
            "msg_id":"123ab45",
            "msg_type":"TRANSACTION",
            "msg_function":"REP_REFINANCE_TRANSACTION",
            "src_application":"IVR",
            "target_application":"WAY4",
            "timestamp":"2020-05-21T15:13:18.853+04:00",
            "tracking_id":"uriyr3487243",
            "bank_id":"NIC",
            "instance_id":null
         },
         "exception_details":{
            "application_name":"NITIBCO",
            "date_time":"2020-05-21T15:13:18.853+04:00",
            "status":"S",
            "error_code":"000",
            "error_description":"Success",
            "transaction_ref_id":null
         }
      }
   }
}

Docs Navigation