• Register

Card Details

Card Details service is used or querying card details, 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: "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 or

EXID

 Mandatory
card_expiry_date String 4 YYMM Ex: 2310 Optional

card_sequence_number

String

2

Sample Values 01, 02 etc

For C+ only

Conditional
Request Json
{
  "NISrvRequest":{
    "request_card_details":{
      "header":{
        "msg_id":"236001",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_DETAILS",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"bankID"
      },
      "body":{
        "card_identifier_id":"454545XXXXXX1234",
        "card_identifier_type":"CONTRACT_NUMBER/EXID",
        "card_expiry_date":"2310",
        "card_sequence_number":"01"
      }
    }
  }
}

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 CIF ID Mandatory

institution_id

String

5

982

Conditional(Mandatory only for credit cards)

card_identifier_type

String

20

CONTRACT_NUMBER or

EXID

Mandatory
card_identifier_id String 32 454545XXXXXX1234 Mandatory
masked_pan  String 16 Masked PAN Mandatory

card_expiry_date

String

4

2310

Mandatory

cardholder_name

String

26

JOHN DOE

Mandatory

account_number

String

50

0009998410029029341

Mandatory

product_code

String

50

Product Code

Optional
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_role

String

1

P (Primary) / S (Supplementary)

Mandatory

last_statement_date

String

10

Last Statement Date

Conditional(Mandatory only for credit cards)

next_statement_date

String

10

Next Statement Date

Conditional(Mandatory only for credit cards)

due_date

String

10

Due Date

Conditional(Mandatory only for credit cards)

card_date_open

String

10

Card open date

Mandatory

card_activation_date

String

10

Card activation date

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 Mandatory
max_pin_attempt String 3 Max pin attempt Mandatory
last_payment_date String 10 last payment date Mandatory
last_payment_amount String 10 last payment amount Mandatory
# 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

102.23

Optional

# Array of Custom Field entity#

custom_fields

key

String

32

 Refer to Appendix 4 Optional
value String 128 Refer to Appendix 4 Optional


 

Json Response

{
  "NISrvResponse":{
    "response_card_details":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_CARD_DETAILS",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-06-14T11:06:36.588+04:00",
        "tracking_id":"56000",
        "bank_id":"bankID",
        "instance_id":"56000"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2020-07-16T10:33:47.934+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      },
      "body":{
        "customer_id":"001051117",
        "institution_id":"982",
        "card_identifier_id":"479746XXXXXX6373",
        "card_identifier_type":"CONTRACT_NUMBER/EXID",
        "card_expiry_date":"2310",
        "cardholder_name":"JOHN DOE",
        "account_number":"0009998410029029341",
        "product_code":,
        "card_role":, # P (Primary) / S (Supplementary)
        "last_statement_date":,
        "next_statement_date":,
        "due_date": "",
        "card_date_open": "",
        "card_activation_date": "",
        "currency": "",
        "last_payment_date":"00/00/0000",
        "last_payment_amount":"0",
        "statuses": [ # Array of Status Entity#
            {
                "type": "card_status",
                "value": "",
                "changed_date": ""
            }
       ],   
        "limits":[ #Array of Limit Entity#
            { 
                "type":"OVL", 
                "currency":"AED", 
                "value":"0.00" 
            },
            { 
                "type":"FIN_LIMIT", 
                "currency":"AED", 
                "value":"50000.00"
            },
            { 
                "type":"CR_LIMIT",
                "currency":"AED",
                "value":"50000.00" 
            },
            { 
                 "type":"AV_CASH_LIM", 
                 "currency":"AED", 
                 "value":"30000" 
            },
            {  
                 "type":"TOTAL_CASH_LIM", 
                 "currency":"AED",
                 "value":"30000" 
            }
        ],
        "balances": [ #Array of Balance Entity#
            {
                "type": "XXX",
                "currency": "AED",
                "amount": "100.25"
            }
        ],
        "custom_fields" : [ # Array of Custom Field entity
            {
                "key": "card_digital_indicator",
                "value": "2"
             },
            {
                "key": "",
                "value": ""
            }
        ]
      }
    }
  }
}
[Credit Limit, Credit Limit %]

version 11 as of 11 months ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation