• Register

Card Direct Debit Update

This service is used by bank to update Insurance product of particular Account. 

Request Parameters:

Node Child Node   Type Length 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_DIRECT_DEBIT_UPDATE" Mandatory
src_application String 10 Source requesting channel e.g. “SSP”. Might change. Mandatory
target_application String 10 Target application name Ex. : "WAY4" 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 e.g. “XXXX” Mandatory
body card_identifier_id String 32 Account or card contract number Mandatory 
card_identifier_type String 20 CONTRACT_NUMBER or EXID Mandatory 
branch_code String 10 Branch code e.g. “XXXX” Mandatory 
dd_day String 2 Direct debit day Optional
dd_number String 17 Direct debit number Optional
dd_percentage String 3 Direct debit percentage Optional
dd_enrolment String 32 Direct debit enrolment flag
Possible values: Y,N,F		 Optional
dd_member String 10 Direct debit member id Optional
custom_fields src_app_name String 32 Free text sent by the bank, to identify the calling application. Optimised for machine-readable processing like grouping and filtering. Optional
src_app_code String 32 Free text sent by the bank, to identify the calling application. Optimised for machine-readable processing like grouping and filtering. Optional
ext_user_id String 32 Free text sent by the bank, to identify the external system’s user. Optional


 Request JSON

{
  "NISrvRequest":{
    "request_card_direct_debit_update":{
      "header":{
        "msg_id":"14551014",
        "msg_type":"ENQUIRY",
        "msg_function":"REQ_CARD_DIRECT_DEBIT_UPDATE",
        "src_application":"IVR",
        "target_application":"WAY4",
        "timestamp":"2020-07-20T10:49:02.366+04:00",
        "tracking_id":"236001",
        "bank_id":"AJMN"
      },
      "body":{
        "card_identifier_id": "52901612XXXXXXXX",
        "card_identifier_type": "CONTRACT_NUMBER",
        "branch_code": "031",
        "dd_day": "",
        "dd_number": "",
        "dd_percentage": "",
        "dd_enrolment":"",
        "dd_member":"",
        "custom_fields": {
                    "key": "",
                    "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. “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_DIRECT_DEBIT_UPDATE”

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

Json Response

{
    "NISrvResponse": {
        "response_card_direct_debit_update": {
            "header": {
                "msg_id": "185098114",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_CARD_DIRECT_DEBIT_UPDATE",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2023-02-24T13:29:18.264+04:00",
                "tracking_id": "236001",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-24T13:29:18.264+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success"
            }
        }
    }
}

version 6 as of 2 years ago by sumit ojha

0 Comments

Please sign in to post a comment.

Docs Navigation