Card Details

Card Details service is used or querying card details, below are the detailed specifications of this API.

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_DETAILS"	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	N/A	Optional
	bank_id	String	4	Source Bank Id Ex: bankID	Mandatory
	instance_id	String	10	N/A	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
	card_expiry_date	String	4	YYMM Ex: 2310	Optional
	card_sequence_number	String	2	Sample Values 01, 02 etc	Optional

Request Json

{
  "NISrvRequest": {
    "request_card_details": {
      "header": {
        "msg_id": "236001",
        "msg_type": "ENQUIRY",
        "msg_function": "REQ_CARD_DETAILS",
        "src_application": "IVR",
        "target_application": "WAY4",
        "timestamp": "2020-07-20T10:49:02.366+04:00",
        "bank_id": "NIC"
      },
      "body": {
        "card_identifier_id": "99984100111514120378",
        "card_identifier_type": "EXID",
        "card_expiry_date": "2812",
        "card_sequence_number": "1"
      }
    }
  }
}

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_ DETAILS”	Mandatory
	src_application		String	10	The src_application sent in the request will be sent back in response in this field.	Mandatory
	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 Date & time. Format “DD/MM/YYYY HH:MM:SS”	Mandatory
	tracking_id		String	15	N/A	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 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	customer_id		String	20	Customer Identification number. This should be a unique number.	Mandatory
	institution_id		String	5	Institution id is the code that is created for each bank or FI(it is the same value as bank code), 982 value is just used as an example in Sandbox.	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
	card_identifier_id		String	32	454545XXXXXX1234	Mandatory
	masked_pan		String	16	Masked PAN of the card	Mandatory
	clear_pan		String	16	Clear card no of the card	Optional
	card_expiry_date		String	4	YYMM Ex: 2310	Mandatory
	cardholder_name		String	26	Card holder's name. Should be capital letters. Ex: JOHN DOE	Mandatory
	account_number		String	50	Account Number. Ex: 0009998410029029341	Mandatory
	product_code		String	50	Product Code	Optional
	card_role		String	1	P (Primary) / S (Supplementary)	Mandatory
	last_statement_date		String	10	Last Statement Date	Mandatory
	next_statement_date		String	10	Next Statement Date	Mandatory
	due_date		String	10	Due date - This is applicable only for the credit cards	Mandatory
	card_date_open		String	10	Card open date	Mandatory
	card_activation_date		String	10	Card activation date Ex: 01/01/2025	Mandatory
	currency		String	3	Currency , Example - AED	Mandatory
	card_virtual_indicator		String	1	P for Physical, V for virtual	Mandatory
	current_pin_attempt		String	3	Current pin attempt	Optional
	max_pin_attempt		String	3	Max pin attempt	Optional
	due_date_with_grace_period		String	10	Due date with grace period	Optional
	product_profile		String	3	Product PCT	Optional
	billing_day		String	2	Billing calendar day	Optional
	plastic_issuance_date		String	10	Date of plastic issuance	Optional
	statement_delivery		String	1	Statement report delivery type	Optional
	renewal_flag		String	1	Renewal flag	Optional
	# Array of linked accounts#
	linked_accounts	account_number	String	60	Account Number	Optional
		account_type	String	15	Current/Saving	Optional
		account_role	String	15	Primary/Supplimentary	Optional
	# Array of Status Entity#
	statuses	type	String	10	card_status	Optional
		value	String	10	Refer to values	Optional
		changed_date	String	10	Changed Date	Optional
		description	String	100	Description	Optional
	#Array of Limit Entity#
	limits	type	String	10	Refer to limits	Optional
		currency	String	3	Currency	Optional
		value	String	12	amount	Optional
	#Array of Balance Entity# Not applicable for Debit Card
	balances	type	String	32	Possible types will be: AVAILABLE, BLOCKED, TOTAL_BALANCE, TOTAL_DUE, DUE (MTP), PAST_DUE, IPP_RET-LOAN-UNB (Ipp Retail Loan Unbilled), REPAYABLE = Outstanding Balance that can be repaid, PAYMENT (Total amount of payment in cycle), DIRECT_DEBIT, OVL.	Mandatory (Note that List of balances types may vary from each CMS system)
		currency	String	3	AED	Optional
		amount	String	20	Balance amount. Ex: 102.23	Optional
	# Array of Custom Field entity#
	custom_fields	key	String	32	Refer to Appendix 4	Optional
	custom_fields	value	String	128	Refer to Appendix 4	Optional

Json Response

{
  "NISrvResponse": {
    "response_card_details": {
      "header": {
        "msg_id": "236001",
        "msg_type": "ENQUIRY",
        "msg_function": "REP_CARD_DETAILS",
        "src_application": "IVR",
        "target_application": "WAY4",
        "timestamp": "2020-07-20T06:49:02.366Z",
        "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": {
        "customer_id": "100000027",
        "institution_id": "982",
        "card_identifier_id": "99984100111514120000",
        "card_identifier_type": "EXID",
        "masked_pan": "999841XXXXXX5605",
        "clear_pan": "9998410029355605",
        "card_expiry_date": "3001",
        "cardholder_name": "JOHN DOE",
        "account_number": "0009821110000000049",
        "product_code": "982_AED_002_P",
        "product_group": "",
        "product_short_code": "",
        "product_name": "",
        "card_brand": "",
        "card_role": "P",
        "last_statement_date": "",
        "next_statement_date": "15/01/2025",
        "due_date": "",
        "card_date_open": "01/01/2022",
        "card_activation_date": "01/01/2025",
        "currency": "AED",
        "card_virtual_indicator": "V",
        "current_pin_attempt": "1",
        "max_pin_attempt": "2",
        "due_date_with_grace_period": "03/03/2025",
        "product_profile": "300",
        "billing_day": "15",
        "plastic_issuance_date": "03/03/2025",
        "statement_delivery": "E",
        "renewal_flag": "Y",
        "linked_accounts": [
          {
            "account_number": "",
            "account_type": "",
            "account_role": ""
          }
        ],
        "statuses": [
          {
            "type": "BCC-CARD-982",
            "value": "_",
            "changed_date": "",
            "description": "SPACE"
          }
        ],
        "limits": [
          {
            "type": "FIN_LIMIT",
            "currency": "AED",
            "value": "55000"
          }
        ],
        "balances": [
          {
            "type": "",
            "currency": "",
            "amount": ""
          }
        ],
        "custom_fields": [
          {
            "key": "",
            "value": ""
          }
        ]
      }
    }
  }
}

[Credit Limit, Credit Limit %]

Card Details

0 Comments

Docs Navigation