• Register

List Of Cards

This service is used for getting list of cards for a particular client or account. This service is applicable for Credit and Debit Cards. 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 Customer ID and Card Type are required as part of input if card number is not providing.
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

 

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_LIST_OF_CARDS”

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

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 | account_number

String

64

Customer Id or Account number

Mandatory

cards

card_number

string

16-19

Card Number

Mandatory
card_display_name String 50 Embossed name Mandatory
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
card_virtual_indicator  String 1 P/V Conditional(Only for Debit Cards)

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
Response Json
{
  "NISrvResponse":{
    "response_list_of_cards":{
       "header":{
        "msg_id":"56000",
        "msg_type":"ENQUIRY",
        "msg_function":"REP_LIST_OF_CARDS",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-06-14T11:06:36.588+04:00",
        "tracking_id":"56000",
        "bank_id":"SSP",
        "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": "000003548435901",
        "cards": [
		{
			"card_number":"479746XXXXXX6373",
        		"card_expiry_date":"",
        		"card_role":"",
        		"account_number":"",
        		"product_code":"",
                        "card_virtual_indicator": "P",
       			"statuses": [ # Array of Status Entity#
            		{
                	  "type":,
                	  "value":,
                	  "changed_date":
            		}
		   ]	
		},
	]
      }
    }
  }
}

version 3 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation