Card Details

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_number

String

Min – 16 Max - 19

16/19-digit card no

e.g: XXXXXXXXXXXX0833

First 6 digits will be BIN for cards

Mandatory

card_sequence_number

String

2

Sample Values 01, 02 etc

For C+ only

Conditional

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

institution_id

String

5

982

Conditional(Mandatory only for credit cards)

card_number

String

Min-16

Max-19

479746XXXXXX6373

Mandatory

card_expiry_date

String

4

2310

Mandatory

cardholder_name

String

50

JOHN DOE

Mandatory

account_number

String

50

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

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

# Array of Status Entity#

statuses

type

String

10

Optional

value

String

10

Refer to values

Optional

changed_date

String

10

Changed Date

Optional

#Array of Limit Entity#

limits

type

String

10

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

Applicable for Debit Cards only.