• Register

Get Account Balance

Account Balance Enquiry service is used for getting the balance details of a given account number, below are the detailed specifications of this API.

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_ACCOUNT_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 account_identifier_type String 20 CONTRACT_NUMBER or EXID Optional 
account_identifier_id
 String 32 454545XXXXXX1234 Mandatory 
balance_list String 15 AVAILABLE,BLOCKED,TOTAL_BALANCE Optional
Request Json
{
  "NISrvRequest": {
    "request_account_balance_enquiry": {
      "header": {
        "msg_id": "12323JJ2JJ",
        "msg_type": "ENQUIRY",
        "msg_function": "REQ_ACCOUNT_BALANCE_ENQUIRY",
        "src_application": "BNK",
        "target_application": "WAY4",
        "timestamp": "2023-03-03T17:01:21.609+04:00",
        "tracking_id": "12323JJ2JJ",
        "bank_id": "NIC"
      },
      "body": {
        "account_identifier_type": "CONTRACT_NUMBER",
	"account_identifier_id": "00098XXXXXXX0000103"
      }
    }
  }
}

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_ACCOUNT_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
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 parent_account_number String 20 Account Number Mandatory
balances (Available/Due Amount) type String 32

AVAILABLE,

BLOCKED,

TOTAL_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":{
  "NISrvResponse": {
    "response_account_balance_enquiry": {
      "header": {
        "msg_id": "12323JJ2JJ",
        "msg_type": "ENQUIRY",
        "msg_function": "REP_ACCOUNT_BALANCE_ENQUIRY",
        "src_application": "BNK",
        "target_application": "WAY4",
        "timestamp": "2023-03-03T16:59:55.855+04:00",
        "tracking_id": "12323JJ2JJ",
        "bank_id": "NIC"
      },
      "exception_details": {
        "application_name": "TCC-ADP",
        "date_time": "2023-03-03T16:59:55.855+04:00",
        "status": "S",
        "error_code": "000",
        "error_description": "Success"
      },
      "body": {
        "parent_account_number": "0009822XXXXX000171",
        "balances": [
          {
            "type": "AVAILABLE",
            "currency": "AED",
            "amount": "0.0"
          },
          {
            "type": "BLOCKED",
            "currency": "AED",
            "amount": "0.0"
          },
          {
            "type": "TOTAL_BALANCE",
            "currency": "AED",
            "amount": "0.0"
          }
        ]
      }
    }
  }
}


version 5 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation