• Register

Card Balance Conversion Enquiry

Card Balance Conversion Enquiry service is used to fetch details about balance conversion for the card details provided. This service is applicable for Credit and Debit Cards. Below are detailed the specifications of this API.

Download

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_CARD_BALANCE_CONVERSION_ENQUIRY" Mandatory
src_application String 10 Source requesting channel e.g. “SSP”. Might change. Mandatory
target_application String 10 Target application name Ex. : "WAY4" 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
body card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory 
card_identifier_id String 32 454545XXXXXX1234 Mandatory

 

Request Json
{
  "NISrvRequest":{
    "request_card_transaction_epp_conversion":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_BALANCE_CONVERSION_ENQUIRY",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "card_identifier_id":"454545XXXXXX1234",
        "card_identifier_type":"CONTRACT_NUMBER",
      }
    }
  }
}

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 Default: “REP_CARD_BALANCE_CONVERSION_ENQUIRY” 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. “SSP”		 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
body card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory
card_identifier_id String 32 454545XXXXXX1234 Mandatory
balances String 32 Type of the balance (In this service: BALANCE_CONVERSION_AVAILABLE) Mandatory
  String 3 Currency Mandatory
  String 20 Amount Mandatory

 

Response Json
{
  "NISrvResponse":{
    "response_card_balance_enquiry":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_CARD_BALANCE_CONVERSION_ENQUIRY",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2020-06-14T11:06:36.588+04:00",
        "tracking_id":"56000",
        "bank_id":"bankID",
        "instance_id":"56000"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2020-07-16T10:33:47.934+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
        "card_identifier_type":"CONTRACT_NUMBER/EXID",
        "card_identifier_id":"454545XXXXXX1234",   
        "balances": [ #Array of Balance Entity#
            {
                "type": "BALANCE_CONVERSION_AVAILABLE",
                "currency": "AED",
                "amount": "1500.25"
            }
        ]
      }
    }
  }
}

version 4 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation