• Register

Card Balance Enquiry

Card Balance Enquiry service is used for getting the balance details of a given card number. This service is applicable only for Credit Cards. Below are the detailed 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_ENQUIRY " Mandatory
src_application String 10 Source requesting channel Ex: IVR. 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 Ex: bankID Mandatory
body card_number String Min – 16 Max - 19 16/19-digit card no Mandatory 
e.g: XXXXXXXXXXXX0833
First 6 digits will be BIN for cards
card_expiry_date String 4 Format YYMM Optional
card_sequence_number String 2 Sample -01,02 etc Conditional
Request Json
{
  "NISrvRequest":{
    "request_card_balance_enquiry":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_ BALANCE_ENQUIRY",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "card_number":"479746XXXXXX6373",
        "card_expiry_date":"2310",
        "card_sequence_number":"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. 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 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
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. Mandatory
instance_id String 10 N/A Optional
Exception_details application_name String 20 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 customer_id String 20 CIF ID Mandatory
institution_id String 5 Bank code Mandatory
card_number String 16-19 e.g: XXXXXXXXXXXX0833. First 6 digits will be BIN for cards Mandatory
card_expiry_date String 4 Card Expiry Date Mandatory
cardholder_name String 50 Cardholder name Mandatory
account_number String 64 Account number Mandatory
Balances (Available/Due Amount) type String 32 Type of the balance Mandatory (Note that List of balances types may vary from each CMS system)
currency String 3 Currency Mandatory
amount String 20 Amount Mandatory

Json Response

{
  "NISrvResponse":{
    "response_card_balance_enquiry":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_CARD_ BALANCE_ENQUIRY",
        "src_application":"IVR",
        "target_application":"PCMS",
        "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":{
        "customer_id":"001051117",
        "institution_id":"982",
        "card_number":"479746XXXXXX6373",
        "card_expiry_date":"2310",
        "cardholder_name":"JOHN DOE",
        "account_number":"0009998410029029341",        
        "balances": [ #Array of Balance Entity#
            {
                "type": "XXX",
                "currency": "AED",
                "amount": "100.25"
            }
        ]
      }
    }
  }
}


version 3 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation