• Register

Card Status Update

Card Status Update service is used for updating the status of card. Status can be updated to active, blocked, lost, stolen etc. 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_CARD_STATUS_CHANGE"

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

 

 

card_number

String

Min – 16 Max - 19

e.g: XXXXXXXXXXXX0833

First 6 digits will be BIN for cards

Mandatory 

card_expiry_date

String

4

YYMM Ex: 2605

Optional

wallet_id String 20 For prepaid cards only

Conditional

status type String 32 card_status Mandatory
value String 32 Refer to satus_values Mandatory

custom_fields

key

String

32

Custom Tag

Optional

value

String

128 Tag value Optional

 

 Request Json

{
  "NISrvRequest":{
    "request_card_status_change":{
      "header":{
        "msg_id":"224001",
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_CARD_STATUS_CHANGE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-19T13:04:30.356+04:00",
        "tracking_id":"224001",
        "bank_id":"bankID"
      },
      "body":{
        "card_number":"999841XX298XX733",
        "card_expiry_date": "",
        "wallet_id": "", -- PCMS ONLY
        "status": {
            "type":"card_status",
            "value":""
        }
      }
    }
  }
}

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. “afef123456”

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

Function name to be used. Default: "REP_CARD_STATUS_CHANGE"

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

Response Json
{
  "NISrvResponse":{
    "response_card_status_change":{
      "header":{
        "msg_id":"224001",
        "msg_type":"TRANSACTION",
        "msg_function":"REP_CARD_STATUS_CHANGE",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"19/07/2020 13:04:31",
        "tracking_id":"224001",
        "bank_id":"bankID"
      },
      "exception_details":{
        "application_name":"NITIB_TCC_ADP_SSP_1",
        "date_time":"2020-07-19T12:57:49.439+04:00",
        "status":"S",
        "error_code":"000",
        "error_description":"Success",
        "transaction_ref_id":null
      }
    }
  }
}
N/A

Docs Navigation