Skip to content

Account Status Change

Account status update API will be used to update the block code on account level for a given account identifier.

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_STATUS_CHANGE " 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 account_identifier_id String 32 Eg: "account_identifier_id": "999851XXXXXX965685"
Mandatory 
account_identifier_type String 20 CONTRACT_NUMBER Mandatory 
status type String 32

BCC-ACC1-%FI_CODE%

BCC-ACC2-%FI_CODE%


Mandatory
value String 32 Refer to status_values
Mandatory
custom_fields[]
array of {"key":"key here", "value:"value here"}
key String 32 Refer to Appendix 4
Optional
Value String 128 Refer to Appendix 4 Optional

Request JSON

{
    "NISrvRequest": {
        "request_account_status_change": {
            "header": {
                "msg_id": "1692103705",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_ACCOUNT_STATUS_CHANGE",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2023-03-03T17:01:21.609+04:00",
                "tracking_id": "13221413256",
                "bank_id": "NIC"
            },
            "body": {
                "account_identifier_type": "CONTRACT_NUMBER",
                "account_identifier_id": "0003621110000000183",
                "status": {
                    "type": "BCC-ACC2-362",
                    "value": "C"
                },
                "custom_fields": [
                    {
                        "key": "bc_channel",
                        "value": "TIB1"
                    }
                ]
            }
        }
    }
}


 Response Parameters:

Node Child Node Data 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_STATUS_CHANGE” Mandatory
src_application String 10 The src_application sent in the request will be sent back in response in this field.
Source requesting channel e.g. “SSP”
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. E.g. ‘ABCD Mandatory
instance_id String 10 N/A Optional
Exception_details application_name String 20 Tibco 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_account_status_change": {
            "header": {
                "msg_id": "1692103705",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_ACCOUNT_STATUS_CHANGE",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2023-08-15T15:48:25.477+03:00",
                "tracking_id": "13221413256",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-08-15T15:48:25.477+03:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "13221413256"
            }
        }
    }
}