Skip to content

Restriction Enable-Disable

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_ENABLE_DISABLE_RESTRICTION" 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
restriction isAllowed boolean   Is Allowed Optional
restriction_type String 100

Restriction Type

MOTO - Mail Order Telephone Order

INTERNATIONAL - International Transaction

ECOM - e-Commerce

SWIPE - Swipe Payments 

PERS_RESTR_CONTACTLESS - Contactless Transaction

NFC - controls POS transactions only

ATM - ATM Transaction

ANY - Any Debit Transaction

PURCHASE - Purchase Transactions

INTERNATIONAL_SPECIFIC_COUNTRIES - to allow specific countries 

Mandatory
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

 

Request Json

{
  "NISrvRequest":{
    "request_enable_disable_restriction":{
      "header":{
        "msg_id": {{$timestamp}},
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_ENABLE_DISABLE_RESTRICTION",
        "src_application":"FALCON",
        "target_application":"WAY4",
        "timestamp": "{{timestamp1}}",
        "tracking_id": {{$randomInt}},
        "bank_id":"EAND"
      },
      "body":{
        "card_identifier_id":"22272300188631682282",
        "card_identifier_type":"EXID",
        "restriction":{
            "isAllowed": "true",
            "restriction_type": "MOTO",
            "end_date": "2023-09-01"
        }
      }
    }
  }
}

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_ENABLE_DISABLE_RESTRICTION" 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
Date & time. Format  “DD/MM/YYYY HH:MM:SS”
Mandatory
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_get_restriction_usage_details":{
         "header":{
            "msg_id":"123ab45",
            "msg_type":"TRANSACTION",
            "msg_function":"REP_ENABLE_DISABLE_RESTRICTION",
            "src_application":"IVR",
            "target_application":"WAY4",
            "timestamp":"2020-05-21T15:13:18.853+04:00",
            "tracking_id":"uriyr3487243",
            "bank_id":"bankID",
            "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
         }
      }
   }
}/code>