• Register

Get Eligible Plans

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_GET_ELIGIBLE_PLANS" 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 Optional
balance_amount String 28 Balance Amount Optional
action String 15 balance_conversion, balance_transfer, loan Optional
Array of Options

key

options

value

 String 20 Key Optional
String 128 Value Optional
Request Json
{
    "NISrvRequest": {
        "request_get_eligible_plans": {
            "header": {
                "msg_id": "2367060121",
                "msg_type": "ENQUIRY",
                "msg_function": "REQ_GET_ELIGIBLE_PLANS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2022-11-16T10:49:02.366+04:00",
                "tracking_id": "2367060121",
                "bank_id": "AJMN"
            },
            "body": {
                "card_identifier_id": "5395661476468591XX",
                "card_identifier_type": "CONTRACT_NUMBER",
                "trans_id": "",
                "action": "balance_transfer",
                "balance_amount": "2000",
                "options": [
        {
            "key": "BOOK_TYPE",
            "value": "SR02"
        }
            ]
            }
        }
    }
}

 

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_ELIGIBLE_PLANS" 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 Array of plans
plans plan_number String 5 Plan Number Mandatory
  number_of_portions String 4 Number of Portions Mandatory
  interest String 3 Interest Mandatory
Response JSON
{
    "NISrvResponse": {
        "response_get_eligible_plans": {
            "header": {
                "msg_id": "2367060121",
                "msg_type": "ENQUIRY",
                "msg_function": "REP_GET_ELIGIBLE_PLANS",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2023-01-04T15:51:37.76+04:00",
                "tracking_id": "2367060121",
                "bank_id": "AJMN"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-01-04T15:51:37.76+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "plans": [
                    {
                        "plan_number": "60003",
                        "number_of_portions": "3",
                        "interest": "0.0"
                    },
                    {
                        "plan_number": "60006",
                        "number_of_portions": "6",
                        "interest": "0.0"
                    },
                    {
                        "plan_number": "60009",
                        "number_of_portions": "9",
                        "interest": "0.0"
                    },
                    {
                        "plan_number": "70018",
                        "number_of_portions": "18",
                        "interest": "0.0"
                    },
                    {
                        "plan_number": "70024",
                        "number_of_portions": "24",
                        "interest": "0.0"
                    }
                ]
            }
        }
    }
}

version 12 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation