• Register

Get Restriction Usage Details

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: "ENQUIRY" Mandatory
msg_function String 50 Function name to be used Default:  "REQ_GET_RESTRICTION_USAGE_DETAILS" 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
Request Json
{
  "NISrvRequest":{
    "request_get_restriction_usage_details":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_GET_RESTRICTION_USAGE_DETAILS",
        "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"
      }
    }
  }
}

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_RESTRICTION_USAGE_DETAILS" 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 restrictions
restrictions restriction_type String 100

Restriction Type

MOTO - Mail Order Telephone Order

INTERNATIONAL - International Transaction

ECOM - e-Commerce

PERS_RESTR_CONTACTLESS - Contactless Transaction

NFC - controls POS transactions only

ATM - ATM Transaction

ANY - Any Debit Transaction

PURCHASE - Purchase Transactions

INTERNATIONAL_SPECIFIC_COUNTRIES - foreign specific countries

 Optional
isAllowed boolean   Is Allowed Optional
end_date Date   End Date Optional
allowed_values String 100 Allowed values (in case of Restriction-type = INTERNATIONAL_SPECIFIC_COUNTRIES, please input comma seperated list of country codes here) Optional
Response JSON
{
  "NISrvResponse":{
    "response_get_restriction_usage_details":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_GET_RESTRICTION_USAGE_DETAILS",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2022-11-16T11:06:36.588+04:00",
        "tracking_id":"56000",
        "bank_id":"NIC",
        "instance_id":"56000"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2022-11-16T10:33:47.934+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
  "restrictions": [
    {
      "restriction_type": "MOTO",
      "isAllowed": true,
      "end_date": ""
    },
    {
      "restriction_type": "INTERNATIONAL",
      "isAllowed": true,
      "end_date": ""
    },
    {
      "restriction_type": "ECOM",
      "isAllowed": true,
      "end_date": ""
    }
  ]
}

version 17 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation