Skip to content

Card Change PIN

Card Change PIN service is used for updating the PIN of an existing card. 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_PIN_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

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 -01,02 etc

Conditional

(for c+ only)
card_expiry_date String 4 YYMM ex: 2310 Mandatory

encrypted_old_pin

String

20

Encrypted Pin block of new pin to be set.

Ex: 7B47D3321D4A5F63

Mandatory

 

encrypted_new_pin

String

20

Encrypted Pin block of old pin to for verification.

Ex: 7B47D3321D4A5F63

Mandatory 

encryption_method

String

20

ASYNC_ENC,SYMMETRIC_ENC

Mandatory
encryption_key_id String 20 TBD Optional
encryption_key_type String 20 TBD Optional


Request Json
{
  "NISrvRequest": {
    "request_card_pin_change": {
      "header": {
        "msg_id": "12345",
        "msg_type": "TRANSACTION",
        "msg_function": "REQ_CARD_PIN_CHANGE",
        "src_application": "IVR",
        "target_application": "PCMS",
        "timestamp": "2020-05-21T15:13:18.853+04:00",
        "tracking_id": "12345df",
        "bank_id": "bankID",
        "instance_id": null
      },
      "body": {
        "card_number":"479746XXXXXX6373",
        "card_sequence_number":"01",
        "card_expiry_date":"2310",
        "encrypted_old_pin": "9C74D3321D4A5E36",
        "encrypted_new_pin": "7B47D3321D4A5F63",
        "encryption_method": (ASYNC_ENC, SYMMETRIC_ENC),
        "encryption_key_id":, 
        "encryption_key_type":, 
      }
    }
  }
}

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_ PIN_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_pin_change":{
         "header":{
            "msg_id":"123ab45",
            "msg_type":"TRANSACTION",
            "msg_function":"REP_CARD_PIN_CHANGE",
            "src_application":"IVR",
            "target_application":"PCMS",
            "timestamp":"2020-05-21T15:13:18.853+04:00",
            "tracking_id":"uriyr3487243",
            "bank_id":"bankID",
            "instance_id":null
         },
         "exception_details":{
            "application_name":"NITIBCO",
            "date_time":"2020-05-21T15:13:18.853+04:00",
            "status":"S",
            "error_code":"000",
            "error_description":"Success",
            "transaction_ref_id":null
         }
      }
   }
}