• Register

Card PIN Verification

Card PIN Verification service is used for verifying the PIN of an existing card,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_PIN_VERIFICATION"

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_identifier_type

 

String

20

CONTRACT_NUMBER or

EXID

Mandatory 
card_identifier_id String 32 454545XXXXXX1234 Mandatory 
card_sequence_number String 2 Sample 01, 02 etc

Conditional

(For c+ only)
card_expiry_date String 4 YYMM ex: 2310 Optional

encrypted_pin

String

20

Encrypted Pin block of the pin to be set.

Ex: 7B47D3321D4A5F63

Mandatory 

 
encryption_method String 20 SYMMETRIC_ENC

Conditional

(For c+ only)
encryption_key_id String 20 TBD Optional
encryption_key_type String 20 TBD Optional
Sample Request
{
  "NISrvRequest": {
    "request_card_pin_verification": {
      "header": {
        "msg_id": "12345",
        "msg_type": "ENQUIRY",
        "msg_function": "REQ_CARD_PIN_VERIFICATION",
        "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_identifier_type":"CONTRACT_NUMBER/EXID",
        "card_identifier_id":"454545XXXXXX1234",
        "card_sequence_number":"01",
        "card_expiry_date":"2310",
        "encrypted_pin": "9C74D3321D4A5E36",
        "encryption_method": "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_VERIFICATION”

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
Sample Response
{
   "NISrvResponse":{
      "response_card_pin_verification":{
         "header":{
            "msg_id":"123ab45",
            "msg_type":"ENQUIRY",
            "msg_function":"REP_CARD_PIN_VERIFICATION",
            "src_application":"IVR",
            "target_application":"PCMS",
            "timestamp":"2020-05-21T15:13:18.853+04:00",
            "tracking_id":"fhaihfhf23",
            "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
         }
      }
   }
}

version 4 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation