List Of Cards

This service is used for getting list of cards for a particular client or account, below are the detailed specifications of this API.

Download

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: "TRANSACTION"	Mandatory
	msg_function	String	50	Function name to be used Default: "REQ_LIST_OF_CARDS"	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
body	customer_id	String	64	Customer ID (Either customer_id or account_number has to be sent)	Conditional
	account_number	String	64	Account Number (Either customer_id or account_number has to be sent)	Conditional
	card_type	String	32	PREPAID/CREDIT/DEBIT	Mandatory

Request Json

{
  "NISrvRequest":{
    "request_list_of_cards":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_LIST_OF_CARDS",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "customer_id": "0000XXXX901",
        "account_number": "0000XXX01",
        "card_type": "PREPAID"
      }
    }
  }
}

Response Parameters:

Node	Child Node			Type	Max	Description	Remarks
header	msg_id					The msg_id sent in the request will be sent back in response in this field.	Mandatory
				String	12	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_LIST_OF_CARDS”	Mandatory
	src_application					The src_application sent in the request will be sent back in response in this field.	Mandatory
				String	10
	target_application					The target_application sent in the request will be sent back in response in this field.	Mandatory
				String	10
	timestamp					Timestamp of the response	Mandatory
				String	30	Date & time. Format  “DD/MM/YYYY HH:MM:SS”
	tracking_id			String	15	N/A	Optional
	bank_id				4	The bank_id sent in the request will be sent back in response in this field.	Mandatory
				String
Exception_details	application_name			String	20	Application Name	Mandatory
	date_time				30	Timestamp of the response	Mandatory
				String		Format “DD/MM/YYYY HH:MM:SS”
	status				1	Status of the request (S/F)	Mandatory
				String		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 | account_number			String	64	Customer Id or Account number	Mandatory
	cards	card_identifier_type		string	20	CONTRACT_NUMBER or	Mandatory
						EXID
		card_identifier_id		String	32	454545XXXXXX1234	Mandatory
		masked_pan		String	16	Masked Plan Number	Mandatory
		card_display_name		String	50	Embossed name	Mandatory
		contract_name		String	100	Contract Name	Optional
		CIF_number		String	20	CIF Number	Mandatory
		card_expiry_date		string	4	YYMM Ex: 2310	Mandatory
		card_role		String	1	Card Role : Primary/Supplementary	Mandatory
		account_number		String	50	Account number	Mandatory
		product_code		String	32	Product code	Mandatory
		product_group		String	32	Product group	Mandatory
		product_short_code		String	32	Product short code	Mandatory
		product_name		String	32	Product name	Mandatory
		card_brand		String	32	Card brand	Mandatory
		card_virtual_indicator		String	1	P/V	Mandatory
		current_pin_attempt		String	3	Current pin attempt	Mandatory
		max_pin_attempt		String	3	Max pin attempt	Mandatory
		set_pin_indicator		String	3	Additional flag to identify if PIN set was done	Mandatory
		Array of Statuses
		statuses	type	string	32	Satus type	Mandatory
			value	string	32	Status Value	Mandatory
			changed_date	string	10	Changed Date	Mandatory
			description	string	100	Description	Optional
		Array of Balances
		balances	type	string	32	Balance type	Mandatory
			currency	string	32	Ex: AED	Mandatory
			description	string	100	Description	Optional
		Array of Custom Fields
		custom_fields	Key	String	32	Refer to Appendix 4(Reserved for Future Use)	Optional
			value	String	128	Refer to Appendix 4 (Reserved for Future Use)	Optional

Response Json

{
  "NISrvResponse": {
    "response_list_of_cards": {
      "header": {
        "msg_id": "1692181139",
        "msg_type": "ENQUIRY",
        "msg_function": "REP_LIST_OF_CARDS",
        "src_application": "IVR",
        "target_application": "WAY4",
        "timestamp": "2023-08-16T14:18:18.541+04:00",
        "tracking_id": "929",
        "bank_id": "D2C"
      },
      "exception_details": {
        "application_name": "TCC-ADP",
        "date_time": "2023-08-16T14:18:18.541+04:00",
        "status": "S",
        "error_code": "000",
        "error_description": "Success"
      },
      "body": {
        "account_number": "0003332220000000023",
        "cards": [
          {
            "card_identifier_id": "22344401110493718660",
            "card_identifier_type": "EXID",
            "masked_pan": "223444XXXXXX1350",
            "card_display_name": "CROSSBORDER CARD",
            "CIF_number": "1998201227800000001",
            "card_expiry_date": "2807",
            "card_role": "P",
            "account_number": "0003332220000000023",
            "product_code": "333_AED_002_P_5",
            "card_virtual_indicator": "V",
            "statuses": [
              {
                "type": "BCC-ACC1-333",
                "value": "_",
                "changed_date": "",
                "description": "SPACE"
              },
              {
                "type": "BCC-ACC2-333",
                "value": "_",
                "changed_date": "",
                "description": "SPACE"
              },
              {
                "type": "BCC-CARD-333",
                "value": "_",
                "changed_date": "28/07/2023",
                "description": "SPACE"
              },
              {
                "type": "BCINF-SIMPLE_STATUS_A",
                "value": "A",
                "changed_date": "",
                "description": "Active"
              },
              {
                "type": "BCINF-SIMPLE_STATUS_C",
                "value": "A",
                "changed_date": "",
                "description": "Active"
              },
              {
                "type": "PLASTIC",
                "value": "A",
                "changed_date": "25/07/2023",
                "description": "ACTIVE"
              }
            ],
            "balances": [
              {
                "type": "AVAILABLE",
                "currency": "AED",
                "amount": "0.0"
              }
            ]
          }
        ]
      }
    }
  }
}