• Register

Card Balance Enquiry

 

This Service is to retrieve cardholder balance details and basic cardholder client information.

Download

Request Parameters:

Node Child Node Type Max Description Remarks
header msg_id String 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_ENQUIRY" Mandatory
src_application String _ Source requesting channel e.g. “SSP”. Might change. Mandatory
target_application String 10 Target application name Ex. : "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_no String 16 14/16-digit card no
e.g: XXXXXXXXXXXX0833
First 6 digits will be BIN for cards
Mandatory 
terminalID String 8 Sample:
12912912
Optional
terminalLoc String 40 Sample:
ACQUIRER NAME SINGAPORE SG
Optional
rrn String 12 Sample:
909906000435
Optional


Request Json
{
  "NISrvRequest":{
    "request_card_balance_enquiry":{
      "header":{
        "msg_id":"223001",
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_CARD_BALANCE_ENQUIRY",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-19T12:59:21.609+04:00",
        "tracking_id":"223001",
        "bank_id":"NI-Test"
      },
      "body":{
		"card_no":"999841XX18869X2X"		
		}
    }
  }
}

Response Parameters:

Node Child Node Type 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_ENQUIRY” 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. “SSP”  
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
trace String 100   Optional
data String 100   Optional
type String 10   Optional
transaction_ref_id String 20 The tracking_id sent in the request will be sent back in response in this field. Optional
body card_no String 16 14/16-digit card no
e.g: XXXXXXXXXXXX0833
First 6 digits will be BIN for cards
Mandatory
card_embossing_name String 25 Sample:
Muhammad Ahmed
Mandatory
cardholder_name String 25   Mandatory
cardavaillableBalance String 11   Optional
card_status String 4   Optional
single_topup String 25   Optional
topupallowed String 25   Optional
transactionfees String 40   Optional
reloadablecard String 10   Optional
customermobilenumber String 10   Optional
card_validity String 10   Optional
Emirates_id_number String 15   Optional
Emirates_id_expirydate String 8   Optional
Email_id String 50   Optional
Wallet_id String 25   Optional
Reserved1 String 50   Optional
Reserved2 String 50   Optional
Reserved3 String 50   Optional


Response Json

{
  "NISrvResponse":{
    "response_card_balance_enquiry":{
      "header":{
        "msg_id":"223001",
        "msg_type":"TRANSACTION",
        "msg_function":"REP_CARD_BALANCE_ENQUIRY",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"19/07/2020 12:59:23",
        "tracking_id":"223001",
        "bank_id":"NI-Test"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SANDBOX_1",
        "date_time":"2020-07-19T12:57:49.439+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
		  
         "card_no": "999841XX18869X2X",
		 "card_embossing_name":"AXCVXXX",
		 "cardholder_name":"WEXXX"           
      }
    }
  }
}

Docs Navigation