Webhook

Webhook Services

Overview

Our webhook solution ensures that your system receives real-time notifications regarding specific events triggered within the NI system, based on your subscription to the different webhooks.

 
Download
Version
Client Create(Post)

This API is used to create a new cardholder within a financial institution. It can be used to register a new customer and issue them with a card.

Status :Production
Version : V2
Try Out   
SMS Webhook(Post)

You will receive notifications when an event in the NI system triggers the need for an SMS notification.

Status :Production
Version : V2
Try Out   
Card Activation(Post)

This webbook serves to instantly inform your system whenever a card is being activated or has finished activation.

Status :Production
Version : V2
Try Out   
Card Replacement(Post)

This webbook serves to promptly inform your system whenever a card replacement occurs. This helps ensure that important card management activities are communicated accurately and on time. Card replacements are crucial in banking because they affect customer accounts, security, and transaction abilities.

Status :Production
Version : V2
Try Out   
Card Renewal(Post)

This webbook serves to promptly inform your system when a card is renewed. It's a key part of managing cards and providing good customer service. Card renewals are important events that affect both the institution and its customers.

Status :Production
Version : V2
Try Out   
Pin Action(Post)

This webbook serves to promptly inform your system whenever there are PIN-related actions performed on a card. It's important for maintaining card security, overseeing operations, and meeting regulatory requirements in finance. PIN-related actions, as of now we support reset pin counter only.

Status :Production
Version : V2
Try Out   
Card Direct Debit(Post)

This API retrieves direct debit details of specific account details.

Status :Production
Version : V2
Try Out   
Card Direct Debit Update(Post)

This API receives updates on direct debit details of specific accounts used by the bank.

Status :Production
Version : V2
Try Out   
P2P Transfer(Post)

This API facilitates debiting from the "source identifier" and crediting to the "target identifier" for the requested amount within the same financial institution.

Status :Production
Version : V2
Try Out   
Account Transaction(Post)

This API retrieves all accounts within a commercial or multi-currency hierarchy under a specific client ID or account number.

Status :Production
Version : V2
Try Out   
Account Status Change(Post)

This API updates block codes on the account level for an account identifier.

Status :Production
Version : V2
Try Out   
Switch MCC(Post)

This API enables or disables MCC groups/codes for a card.

Status :Production
Version : V2
Try Out   
Release Pending Authorization(Post)

This API cancels pending authorizations. It will only search for pending authorizations.

Status :Production
Version : V2
Try Out   
Get MCC Controls(Post)

This API retrieves all blocked and/or allowed MCC groups and codes.

Status :Production
Version : V2
Try Out   
Account Balance Enquiry(Post)

The Account Balance API receives balance details of account numbers.

Status :Production
Version : V2
Try Out   
Account Hierarchy Enquiry(Post)

This API retrieves all accounts within a commercial or multi-currency hierarchy under a specific client ID or account number.

Status :Production
Version : V2
Try Out   
ThreeDS Webhook(Post)

This webbook serves to instantly inform your system whenever an OTP message needs to be sent to the cardholder.

Status :Production
Version : V2
Try Out   
Authorization Transaction(Post)

This webbook serves to instantly inform your system whenever an authorization transaction occurs.

Status :Production
Version : V2
Try Out   
Account Transfer Status(Post)

This webbook serves to instantly inform your system whenever an account transfer [product transfer] has been processed.

Status :Production
Version : V2
Try Out   
Account Status Change(Post)

This webbook serves to instantly inform your system whenever the account status is changed.

Status :Production
Version : V2
Try Out   
Card Status Change(Post)

This webbook serves to instantly inform your system whenever the card status is changed.

Status :Production
Version : V2
Try Out   
Token Notification(Post)

This Webhook serves to instantly inform your system whenever a tokenization event occurs.

Status :Production
Version : V2
Try Out   

Switch MCC

Status:

Production

Version:

V2

Category:

Webhook

Overview

The Switch MCC API enables the cardholder to seamlessly manage Merchant Category groups, and codes (MCCGs /MCCs), which categorize merchants. This API enables users to update or switch MCCs by enabling or blocking MCCG/MCC, and this will impact the authorization transaction immediately.

How It Works

 

To manage a specific card ID, you can choose to block or allow a list of Merchant Category Codes (MCC) groups, with the option to block or allow MCCs withing each group. For example, suppose you have a group labeled X containing 3 MCC codes 1111,2222,3333. If you want to block group X except for code 3333, you will need to send a request with mcc_blocked_group_list containing group X and mcc_allowed_code_list containing code 3333.  This configuration specifies which MCC groups are blocked overall and which specific MCCs within those groups are allowed.

Overview

The Switch MCC API enables the cardholder to seamlessly manage Merchant Category groups, and codes (MCCGs /MCCs), which categorize merchants. This API enables users to update or switch MCCs by enabling or blocking MCCG/MCC, and this will impact the authorization transaction immediately.

How It Works

To manage a specific card ID, you can choose to block or allow a list of Merchant Category Codes (MCC) groups, with the option to block or allow MCCs withing each group. For example, suppose you have a group labeled X containing 3 MCC codes 1111,2222,3333. If you want to block group X except for code 3333, you will need to send a request with mcc_blocked_group_list containing group X and mcc_allowed_code_list containing code 3333.  This configuration specifies which MCC groups are blocked overall and which specific MCCs within those groups are allowed.

https://api-sandbox.network.global

Switch MCC

Status:

Production

Version:

V2

Category:

Webhook
/CardControl/Transaction/V2/SwitchMCC
curl --location --request POST '#{PARAM_URL}' --header 'Authorization: Bearer {{ access_token }}' {custom_headers} --data-raw '#{JSON_PAYLOAD}'
curl --location --request GET 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'
curl --location --request POST 'https://api-sandbox.network.global/v1/tokenkc/generate' \--data-raw '#{JSON_PAYLOAD}'

Node Child Node Type Length Description
Authorization* requiredBearer xxxx* requiredstringAuthorization Header (Bearer Token)
Content-Type* requiredapplication/json* requiredstringContent Type

Node TypeTypeLengthDescription
NISrvRequestrequest_enable_disable_mccheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION”
msg_function* requiredstring50Message functions: Should be “REQ_ENABLE_DISABLE_MCC”
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
bodycard_identifier_id* requiredstring32Card Identifer ID
card_identifier_type* requiredstring20CONTRACT_NUMBER is used for clear card number or EXID which is a unique identifier for the card generated by CMS
mcc_allowed_group_listcodestring30By specifying this array of codes, only the designated MCC groups will be permitted, while all others will be restricted
mcc_blocked_group_listcodestring30By specifying this array of codes, only the designated MCC groups will be restricted, while all others will be permitted
mcc_allowed_code_listcodestring30By specifying this array of codes, only the designated MCC codes will be permitted, while all others will be restricted
mcc_block_code_listcodestring30By specifying this array of codes, only the designated MCC codes will be restricted, while all others will be permitted

{
    "NISrvRequest": {
        "request_enable_disable_mcc": {
            "header": {
                "msg_id": "4052182325",
                "msg_type": "TRANSACTION",
                "msg_function": "REQ_ENABLE_DISABLE_MCC",
                "src_application": "BNK",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "body": {
                "card_identifier_id": "99984104111610175918",
                "card_identifier_type": "EXID",
                "mcc_blocked_group_list": [
                    {
                        "code": "Tickets"
                    }
                ],
                "mcc_allowed_code_list": [
                    {
                        "code": "5523"
                    },
                    {
                        "code": "5599"
                    }
                ],
                "mcc_blocked_code_list": [
                    {
                        "code": "6623"
                    },
                    {
                        "code": "6699"
                    }
                ]
            }
        }
    }
}

Node Child Node Type Length Description
Content-Typeapplication/jsonstringContent Type

Node TypeTypeLengthDescription
NISrvResponseresponse_enable_disable_mccheadermsg_id* requiredstring12Message ID, this field should be unique id for each Api call. This will be generated from client side. If the same message ID is used the system will decline the API call with Error Description “Duplicate Message ID”
msg_type* requiredstring12Message Type – This can have either “TRANSACTION” or “ENQUIRY” As for this API the value expected is “TRANSACTION ”
msg_function* requiredstring50Message functions: Should be “REP_ENABLE_DISABLE_MCC”
src_application* requiredstring10Source Application: This is a free Text and the client can populate the source system from where the API is Initiated Example: IVR, IB, MB No Validations of these are kept at Network Systems
target_application* requiredstring10The target_application can hold any value from FI side, this can be used by FI to check the target system of the API call
timestamp* requiredstring30Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
bank_id* requiredstring4Bank Id is Unique Id 4 digit code for each client and the same will be provided once the client setup is completed in our core system. For sandbox testing – Please use “NIC”
exception_detailsapplication_name* requiredstring20Application Name
date_time* requiredstring30Timestamp of the response Format “YYYY-MM-DD HH:MM:SS”
status* requiredstring1Status of the request (S/F)
error_code* requiredstring4EAI Internal Error Code (Check error codes section for the complete list of error codes and error code descriptions)
error_description* requiredstring100Error Description (Check error codes section for the complete list of error codes and error code descriptions)
transaction_ref_idstring20The tracking_id sent in the request will be sent back in response in this field.

{
    "NISrvResponse": {
        "response_enable_disable_mcc": {
            "header": {
                "msg_id": "236001",
                "msg_type": "TRANSACTION",
                "msg_function": "REP_ENABLE_DISABLE_MCC",
                "src_application": "IVR",
                "target_application": "WAY4",
                "timestamp": "2020-07-20T10:49:02.366+04:00",
                "bank_id": "NIC"
            },
            "exception_details": {
                "application_name": "TCC-ADP",
                "date_time": "2023-02-01T16:39:47.314+04:00",
                "status": "S",
                "error_code": "000",
                "error_description": "Success",
                "transaction_ref_id": "236001"
            }
        }
    }
}

Code Description
200Sample Description
400Bad Request
401Unauthorized
403Forbidden
500Internal Server Error
502Bad gateway
503Scheduled Maintenance
504Gateway Timeout
596Service Not Found

How It Works

Follow the steps below. For more details, read the Quick Start Guide.

1- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

2- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

3- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

4- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.

5- Process 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Amet, sed at amet cras fringilla adipiscing nunc, in pulvinar. Sagittis pellentesque leo et proin convallis justo vitae in.