Balance Inquiry

Balance Inquiry service is used to make request for fetching balance details for the given card_number & type of account with some other fields as well, Below are the detailed specifications of this API.

Download

Request Parameters:

Node	Type	Max	Description	Sample	Remarks
Message_Version	String	Up to 8 Char	Version of the message based on NI Issuing API spec.	1	Required
Message_Type	String	20 char	The Message Type Identifier (MTI) is a four-digit numeric data element describing the type of message being interpreted.	Balance_Inquiry_Rqst	Required
CARD_NUMBER	Number	B/n 13 and 19 Char	Payment card number used in transaction.	470468******5980	Required
From_Account	String	6 char	Cardholder “From Account” Type Code) describes the cardholder account type affected for cardholder account debits and inquiries and the “from account” type example are Saving, Credit and Current	Saving	Required
Transmission_Date_Time	String	14 char	(Transmission Date and Time) is the date and time that a message is entered into the MasterCard Network. Date and time must be expressed in Coordinated Universal Time (UTC).	01/11/yy 14:11:53	Required
System_Trace_Audit_Number	Number	6	(Systems Trace Audit Number [STAN]) is a number a message initiator assigns to Uniquely identify a transaction.	759099	Required
Local_Date_Time	String	8 char	(Time, Local Transaction) is the local time at which the transaction takes place at the	0.757372685	Required
Card_Expiry_Date	String	8 char	(Date, Expiration) specifies the year and month after which an issuer designates a Cardholder’s card to be “expired.”	dd/05/25	Required
Currency_Conversion_Date	String	8 char	(Date, Conversion) indicates the effective date of Conversion Rate, Settlement and also Conversion Rate, Cardholder Billing whenever these data elements are Present within a message.	09/16/yy	Required
Capture Date	String	8 char	(Date, Capture) is the month and day the acquirer processed the transaction data.	01/11/yy	Required
POS_Enty_Mode	Number	3 char	(Point-of-Service [POS] Entry Mode) indicates the method used for PAN entry to initiate a transaction and the PIN entry capabilities. Subfield 1 (POS Terminal PAN Entry Mode) indicates the method used for PAN entry to initiate a transaction. (2 char). subfield 2 (POS Terminal PIN Entry Mode) describes the capability of the terminal device to support/accept PIN entry. (1 char)	51	Required
Card_Sequence_Number	String	3 char	distinguishes among separate cards having the same (Primary Account Number [PAN])	0	Required
Acquiring_Institution_Code	String	6 char	(Acquiring Institution ID Code) identifies the acquiring institution (for example, Merchant bank) or its agent.	587387	Required
Retrieval_Reference_Number	Number	12 char	(Retrieval Reference Number) is a document reference number supplied by the system retaining the original source document of the transaction and assists in locating that source Document or a copy thereof.	5.1241E+11	Required
Card_Acceptor_Terminal_ID	String	8 char	(Card Acceptor Terminal ID) uniquely identifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems.	ABCD0501	Required
Card_Acceptor_Identification_Code			(Card Acceptor ID Code) identifies the card acceptor that defines the point of the transaction in both local and interchange environments.
Card_Acceptor_Name_Location	String	Up to 40 char	(Card Acceptor Name/Location) contains the name and location of the card acceptor	MALL OF THE EMIRATES DUBAI DUBAE	Required
Currency_Code_Transaction	String	3 char	(Currency Code, Transaction) is the local currency of the acquirer or source location of the transaction.	784	Required
From_Account_No	Number	Up to 28 char	(Account ID-1) is a series of digits that identify a customer account or relationship. Customers primarily use it for the “from” account in a transfer transaction.	101**********105	Required

Request Json

{
    "Message_Version": "1.0",
    "Message_Type": "Balance_Inquiry_Rqst",
    "Card_Number ": "470468******5980",
    "From_Account": "Saving",
    "Transmission_Date_Time": "01/11/yy 14:11:53",
    "System_Trace_Audit_Number": "759099",
    "Local_Date_Time": "01/11/yy 18:10:37",
    "Card_Expiry_Date ": "dd/05/25",
    "Conversion_Date": "09/16/yy",
    "Capture Date": "01/11/yy",
    "POS_Enty_Mode": "051",
    "Card_Sequence_Number": "000",
    "Acquiring_Institution_Code": "587387",
    "Retrieval_Reference_Number": "512410002459",
    "Card_Acceptor_Terminal_ID": "ABCD0501",
    "Card_Acceptor_Identification_Code": "ABCD Bank",
    "Card_Acceptor_Name_Location": "MALL OF THE EMIRATES  DUBAI        DUBAE",
    "Currency_Code_Transaction": "784",
    "From_Account_No": "101**********105"
}

Response parameters:

Name	Type	Max	Description	Sample	Remarks
Message_Version	String	Up to 8 Char	Version of the message based on NI Issuing API spec.	1	Required
Message_Type	String	20 char	The Message Type Identifier (MTI) is a four-digit numeric data element describing the type of	Balance_Inquiry_Rqst	Required
			message being interpreted.
CARD_NUMBER	Number	B/n 13 and 19 Char	Payment card number used in transaction.	470468******5980	Required
From_Account	String	6 char	Cardholder “From Account” Type Code) describes the cardholder account	Saving	Required
			type affected for cardholder account debits and inquiries and the “from account” type example are Saving, Credit and Current
Transmission_Date_Time	String	14 char	(Transmission Date and Time) is the date and time that a message is entered into the MasterCard Network. Date and time must be expressed in Coordinated Universal Time (UTC).	01/11/yy 14:11:53	Required
System_Trace_Audit_Number	Number	6	(Systems Trace Audit Number [STAN]) is a number a message initiator assigns to	759099	Required
			Uniquely identify a transaction.
Local_Date_Time	String	8 char	(Time, Local Transaction) is the local time at which the transaction takes place at the	18:10:37	Required
			Point of card acceptor location.
Card_Expiry_Date	String	8 char	(Date, Expiration) specifies the year and month after which an issuer designates a	dd/05/25	Required
			Cardholder’s card to be “expired.”
Currency_Conversion_Date	String	8 char	(Date, Conversion) indicates the effective date of Conversion Rate, Settlement	09/16/yy	Required
			and also Conversion Rate, Cardholder Billing whenever these data elements are
			Present within a message.
Capture Date	String	8 char	(Date, Capture) is the month and day the acquirer processed the transaction data.	01/11/yy	Required
POS_Enty_Mode	Number	3 char	(Point-of-Service [POS] Entry Mode) indicates the method used for PAN entry to initiate	51	Required
			a transaction and the PIN entry capabilities. Subfield 1 (POS Terminal PAN Entry Mode) indicates the method used for PAN entry to initiate a transaction. (2 char). subfield 2 (POS Terminal PIN Entry Mode) describes
			the capability of the terminal device to support/accept PIN entry. (1 char)
Card_Sequence_Number	String	3 char	distinguishes among separate cards having the same	0	Required
			(Primary Account Number [PAN])
Acquiring_Institution_Code	String	6 char	(Acquiring Institution ID Code) identifies the acquiring institution (for example,	587387	Required
			Merchant bank) or its agent.
Retrieval_Reference_Number	Number	12 char	(Retrieval Reference Number) is a document reference number supplied by the system	5.1241E+11	Required
			retaining the original source document of the transaction and assists in locating that source
			Document or a copy thereof.
Card_Acceptor_Terminal_ID	String	8 char	(Card Acceptor Terminal ID) uniquely identifies a terminal at the card acceptor location	ABCD0501	Required
			of acquiring institutions or merchant POS systems.
Card_Acceptor_Identification_Code	String	15 char		ABCD Bank	Required
			(Card Acceptor ID Code) identifies the card acceptor that defines the point of the transaction in both local and interchange environments.
Card_Acceptor_Name_Location	String	Up to 40 char	(Card Acceptor Name/Location) contains the name and location of the card acceptor	MALL OF THE EMIRATES DUBAI DUBAE	Required
Currency_Code_Transaction	String	3 char	(Currency Code, Transaction) is the local currency of the acquirer or source location of	784	Required
			the transaction.
From_Account_No	Number	Up to 28 char	(Account ID-1) is a series of digits that identify a customer account or relationship. Customers primarily use it for the “from” account in a transfer transaction.	101**********105	Required

Response Json

{
    "Message_Version": "1.0",
    "Message_Type": "Balance_Inquiry_Resp",
    "Card_Number ": "470468******5980",
    "From_Account": "Saving",
    "Transaction_Amount": "000000000000",
    "Transmission_Date_Time": "01/11/yy 14:11:53",
    "System_Trace_Audit_Number": "759099",
    "Local_Date_Time": "01/11/yy 18:10:37",
    "Card_Expiry_Date ": "dd/05/25",
    “Settlement_Date": "01/11/yy",
    "Conversion_Date": "09/16/yy",
    "Capture Date": "01/11/yy",
    "POS_Enty_Mode": "051",
    "Card_Sequence_Number": "000",
    "Acquiring_Institution_Code": "587387",
    "Retrieval_Reference_Number": "512410002459",
    "Approval_Code": "587387",
    "Action_Code": "00",
    "Card_Acceptor_Terminal_ID": "ABCD0501",
    "Additional_Response_Data": "4000000020299000000020299",
    "Currency_Code_Transaction": "784",
    "From_Account_No": "101**********105"
    }

version 11 as of 3 years ago by Siddhant Jain

0 Comments

Please sign in to post a comment.

Balance Inquiry

0 Comments

Docs Navigation