Card Statement summary

Card statement summary service is used for fetching the online card statement for a given card. This service is applicable only for Credit Cards. Below are the detailed specifications of this API.

Request Parameters:

Node	Child Node	Type	Length	Description	Remarks
header	msg_id	String	12	Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”	Mandatory
	msg_type	String	12	Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”	Mandatory
	msg_function	String	50	Static Value - REQ_CARD_STATEMENT_SUMMARY	Mandatory
	src_application	String	10	This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems	Mandatory
	target_application	String	10	The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call	Mandatory
	timestamp	String	30	Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS	Mandatory
	bank_id	String	4	Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”	Mandatory
body	card_identifier_id	String	32	card identifier. Ex: 454545XXXXXX1234	Mandatory
	card_identifier_type	String	20	CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS	Mandatory
	statement_period	String	4	Format MMYY (Maximum statement is 12 months from the current date)	Mandatory

Request Json

{
  "NISrvRequest": {
    "request_card_statement_summary": {
      "header": {
        "msg_id": "236001",
        "msg_type": "ENQUIRY",
        "msg_function": "REQ_CARD_STATEMENT_SUMMARY",
        "src_application": "IVR",
        "target_application": "PCMS",
        "timestamp": "2020-07-20T10:49:02.366+04:00",
        "bank_id": "NIC"
      },
      "body": {
        "card_identifier_id": "454545XXXXXX1234",
        "card_identifier_type": "EXID",
        "statement_period": "0323"
      }
    }
  }
}

Response Parameters:

Node	Child Node			Type	Max	Description	Remarks
header	msg_id			String	12	Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”.	Mandatory
	msg_type			String	12	Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “ENQUIRY”	Mandatory
	msg_function			String	50	Static Value - RES_CARD_STATEMENT_SUMMARY	Mandatory
	src_application			String	10	This is a free Text and the client can populate the source system from where the API is Initiated. Example: IVR, IB, MB No Validations of these are kept at Network Systems	Mandatory
	target_application			String	10	The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call.	Mandatory
	timestamp			String	30	Timestamp of the response Date & time Format DD/MM/YYYY HH:MM:SS	Mandatory
	bank_id			String	4	Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”	Mandatory
Exception_details	application_name			String	20	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_id			String	32	454545XXXXXX1234	Mandatory
	card_identifier_type			String	20	CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS	Mandatory
	statement_period			String	4	Format MMYY (Maximum statement is 12 months from the current date)	Mandatory
	statement_details	statement_date		String	10	Billing Date	Mandatory
		last_statement_date		String	3	Last billing date	Mandatory
		statement_opening_balance		String	20	Statement Opening balance	Mandatory
		statement_closing_balance		String	20	Statement Closing balance	Mandatory
		due_amount		String	20	Due amount	Optional
		due_date		String	10	Statement due date in format YYYY-MM-DD	Optional
		past_due_amount		String	20	Pat due amount	Optional
		full_payment_amount		String	20	Full payment amount/interest free amount	Optional
		interest_this_statement		String	20	Interest amount in selected statement	Optional
		statement_available_balance		String	20	Available amount at the time of statement	Mandatory
		reward_programs	reward_type	string	3	Reward Type	Optional
			reward_open_balance	string	3	Reward Open Balance	Optional
			reward_balance	string	20	Reward balance on the current billing cycle	Optional
			reward_earned	string	20	Reward earned points on the current billing cycle	Optional
			reward_redeemed	string	20	Reward redeemed points on the current billing cycle	Optional
			reward_adjust	string	20	Reward adjust points on the current billing cycle	Optional
			reward_total_earned	string	20	Reward earned points on the current billing cycle	Optional

Response Json

{
  "NISrvResponse": {
    "response_card_statement_summary": {
      "header": {
        "msg_id": "236001",
        "msg_type": "ENQUIRY",
        "msg_function": "RES_CARD_STATEMENT_SUMMARY",
        "src_application": "IVR",
        "target_application": "WAY4",
        "timestamp": "2020-07-20T10:49:02.366+04:00",
        "bank_id": "NIC"
      },
      "exception_details": {
        "application_name": "TCC-ADP",
        "date_time": "2023-02-01T16:39:47.314+04:00",
        "status": "S",
        "error_code": "000",
        "error_description": "Success",
        "transaction_ref_id": "236001"
      },
      "body": {
        "card_identifier_id": "454545XXXXXX1234",
        "card_identifier_type": "CONTRACT_NUMBER/EXID",
        "statement_period": "0323",
        "statement_details": {
          "statement_date": "15/12/2021",
          "last_statement_date": "15/05/2021",
          "statement_opening_balance": "0.00",
          "statement_closing_balance": "6000.00",
          "due_amount": "900.00",
          "due_date": "05/01/2022",
          "past_due_amount": "500.00",
          "full_payment_amount": "6000.00",
          "interest_this_statement": "500.00",
          "statement_available_balance": "5000",
          "reward_programs": [
            {
              "reward_type": "C55",
              "reward_open_balance": "1",
              "reward_balance": "1",
              "reward_earned": "1",
              "reward_redeemed": "1",
              "reward_adjust": "1",
              "reward_total_earned": "1"
            }
          ]
        }
      }
    }
  }
}

Card Statement summary

0 Comments

Docs Navigation