• Register

Card Replacement

Card Replacement service is used to replace cards, below are the detailed specifications of this API.

Download

Request Parameters:

Node Child Node Type Max Description Remarks
header msg_id A/N 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_REPLACEMENT " 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 Transaction Tracking Id 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_expiry_date String 4 Format YYMM Optional
Existing expiry for identification
card_sequence_number String 2 Sample -01,02 etc Conditional (Applicable for C+)
action_type String 20

Renewal, Replacement, Reissue (for Credit and Debit Cards).

ReissAsNew (to convert virtual to Physical)

 Mandatory
new_card_identifier_type  String 20 CONTRACT_NUMBER Optional
new_card_identifier_id String 32 454545XXXXXX1234 Optional
custom_fields                 key String 32 Refer to Appendix 4 Refer to Appendix 4
                                                                                       value String 128 Refer to Appendix 4 Refer to Appendix 4

 Request JSON

{
  "NISrvRequest":{
    "request_card_replacement":{
      "header":{
        "msg_id":"224001",
        "msg_type":"TRANSACTION",
        "msg_function":"REQ_CARD_REPLACEMENT",
        "src_application":"IVR",
        "target_application":"PCMS",
        "timestamp":"2020-07-19T13:04:30.356+04:00",
        "tracking_id":"224001",
        "bank_id":"bankID"
      },
      "body":{
        "card_identifier_type":"CONTRACT_NUMBER",
        "card_identifier_id":"454545XXXXXX1234",
        "card_expiry_date":"",
        "card_sequence_number":"",
        "action_type":"",
        "new_card_identifier_type":"CONTRACT_NUMBER/EXID",
        "new_card_identifier_id":"454545XXXXXX1234",
      }
    }
  }
}

Response Parameters:

Node Child Node Type Length 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_REPLACEMENT” 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 The tracking_id sent in the request will be sent back in response in this field. 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 new_card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory
new_card_identifier_id String 32 454545XXXXXX1234 Mandatory
new_card_expiry_date String 4 YYMM Mandatory
new_masked_pan String 32 454545XXXXXX1234 Mandatory
Response JSON
{
    "NISrvResponse": {
        "response_card_replacement": {
            "header": {
                "msg_id": "1672216526",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_REPLACEMENT",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2022-12-28T12:35:30.739+04:00",
                "tracking_id": "677",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2022-12-28T12:35:30.739+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            },
            "body": {
                "new_card_identifier_id": "99985100168073701912",
                "new_card_identifier_type": "EXID",
                "new_masked_pan": "999851XXXXXX9230",
                "new_card_expiry_date": "2712"
            }
        }
    }
}


version 17 as of 1 year ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation