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

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

SMS Webhook

Status:

Production

Version:

V2

Category:

Webhook

SMS Webhook....

Overview

The SMS Webhook serves to inform your system when an SMS needs to be dispatched to the cardholder.

SMS text generation

This functionality is employed when NI handles SMS text generation, but the message sending is managed by your system.

Predefined templates

Message text generation relies on predefined templates set up at NI for each event.

Contact details

Alongside message text generation, we'll provide the contact details necessary to send the notification back to the cardholder from your side.

How It Works

First the template needs to be defined at NI side, and delivery channel will be defined as your system.
Once SMS is triggered, the SMS Webhook will initiate a request containing relevant information about the event to a predefined URL endpoint.

Node	Child Node	Type	Length	Description
Authorization* required	Bearer xxxx* required	string		Authorization Header (Bearer Token)
Content-Type* required	application/json* required	string		Content Type

Node Type						Type	Length	Description
id						string	20	Unique identifer for the request
type						string	32	Type of the webhook
timestamp						string	30	Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
details	sms	recipient	card	id	value	string	32	Card Identifier
			card	id	type	string	20	externalCardId - when this is used,cardNumber - when clear card number is used
			maskedCardNumber			string	19	Masked PAN number
			clientId			string	21	Client ID
			mobilePhone			string	32	Mobile Number to which the SMS should be triggered
			email			string	255	Email ID
			language			string	3	Language ISO code
		textMessage				string	255	The content of the SMS

{"id":"b876d568-8411-4638-bdef-a1a188a4773b","type":"SMS","timestamp":"2020-07-20T06:49:02.366Z","details":{"sms":{"recipient":{"card":{"id":{"value":"99984100133767425304","type":"externalCardId"}},"maskedCardNumber":"999841XXXXXX7408","clientId":"112233677339066180","mobilePhone":"112211223322","email":"James.Robert@network.global","language":"ENG"},"textMessage":"Thank you for your NI Issuing Core DEMO Visa Gold credit card application. Your NI Issuing Core DEMO credit card ending 0796 was activated with 0.00 AED."}}}

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "SMS",
    "timestamp": "2020-07-20T06:49:02.366Z",
    "details": {
        "sms": {
            "recipient": {
                "card": {
                    "id": {
                        "value": "99984100133767425304",
                        "type": "externalCardId"
                    }
                },
                "maskedCardNumber": "999841XXXXXX7408",
                "clientId": "112233677339066180",
                "mobilePhone": "112211223322",
                "email": "James.Robert@network.global",
                "language": "ENG"
            },
            "textMessage": "Thank you for your NI Issuing Core DEMO Visa Gold credit card application. Your NI Issuing Core DEMO credit card ending 0796 was activated with 0.00 AED."
        }
    }
}

Node	Child Node				Type	Length	Description
Content-Type	application/json				string		Content Type

Node Type			Type	Length	Description
id			string	12	Unique identifer ID
type			string	10	Type of the webhook
timestamp			string	30	Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
response	status	code	string	5	Status code of the response
response	status	description	string	30	Response Description

{"id":"b876d568-8411-4638-bdef-a1a188a4773b","type":"SMS","timestamp":"2020-07-20T06:49:02.366Z","response":{"status":{"code":"00","description":"successful"}}}

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "SMS",
    "timestamp": "2020-07-20T06:49:02.366Z",
    "response": {
        "status": {
            "code": "00",
            "description": "successful"
        }
    }
}

Code	Description
200	Bank Fin Profiles Successfully retrieved
400	Bad request (Refer to the Bussiness Error Table)
401	Indicates that the request requires user authentication information. The client MAY repeat the request with a suitable Authorization header field
404	The server can not find the requested resource.
500	Internal Server Error
502	The server got an invalid response while working as a gateway to get the response needed to handle the request
503	The server is not ready to handle the request.
504	The server is acting as a gateway and cannot get a response in time for a request.
596	Service Not Found

Webhook

Webhook Services

Overview

Client Create(Post)

SMS Webhook(Post)

Card Activation(Post)

Card Replacement(Post)

Card Renewal(Post)

Pin Action(Post)

Card Direct Debit(Post)

Card Direct Debit Update(Post)

P2P Transfer(Post)

Account Transaction(Post)

Account Status Change(Post)

Switch MCC(Post)

Release Pending Authorization(Post)

Get MCC Controls(Post)

Account Balance Enquiry(Post)

Account Hierarchy Enquiry(Post)

ThreeDS Webhook(Post)

Authorization Transaction(Post)

Account Transfer Status(Post)

Account Status Change(Post)

Card Status Change(Post)

Token Notification(Post)

SMS Webhook

Status:

Production

Version:

V2

Category:

Webhook

SMS Webhook....

Overview

SMS text generation

Predefined templates

Contact details

How It Works

SMS Webhook

Status:

Production

Version:

V2

Category:

Webhook

Header Request Parameters

Request Parameters

Sample Request

Header Response parameters

Response parameters

Sample Response

Error Code

How It Works

1- Process 1

2- Process 1

3- Process 1

4- Process 1

5- Process 1