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

Authorization Transaction

Status:

Production

Version:

V2

Category:

Webhook

Overview

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

How It Works

The authorization transactions API Webhook facilitates secure and real-time handling of card authorization activities by sending HTTP POST requests to specified endpoints. This webhook service is used to send issuer notification related to authorizations. This Can be used to send SMS, or push notification to the cardholder along with other activities from the issuer side.

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	36	Unique identifer ID
type				string	10	Type of the webhook
timestamp				string	30	Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
details	transaction	type		string	20	Type of the transaction: Auth/Reversal/Refund/Adjustment
		retrievalReferenceNumber		string	12	RRN
		date		string	10	Transaction Date
		time		string	12	Transaction Time
		currency		string	3	Transaction Currency Code
		amount		string	22	Transaction Amount
		authCode		string	8	Approval Code
		originator	merchantId	string	20	Merchant Number
		originator	terminalId	string	100	Terminal ID
		recipient	maskedCardNumber* required	string	20	Masked Card Number
		recipient	externalCardId	string	30	External Card ID
		status	status	string	10	Transaction Status
		status	code	string	3	Response Code
		request	transactionType	string	50	Transaction Type
			systemTraceAuditNumber* required	string	22	System Trace Audit Number
			originalAmount	string	22	Foreign Transaction Amount
			billingCurrency	string	3	Currency Code
			billingAmount	string	22	Billing Amount
			mcc	string	4	MCC
			country	string	3	Country
			city	string	13	City
			merchantName	string	255	Terminal Location
			cardExpiryDate	string	4	Card Expiry date

{"id":"b876d568-8411-4638-bdef-a1a188a4773b","type":"AuthTransaction","timestamp":"2022-11-09T11:00:03Z","details":{"transaction":{"type":"Auth","retrievalReferenceNumber":"M3150100CL8M","date":"20221111","time":"141344","currency":"784","amount":"11","authCode":"705119","originator":{"merchantId":"123456789000000","terminalId":"98765432"},"recipient":{"maskedCardNumber":"5XXXXXXXXXXXXXX7","externalCardId":"55555555555555555557"},"status":{"status":"successful","code":"001"},"request":{"transactionType":"01","systemTraceAuditNumber":"037961","originalAmount":"","billingCurrency":"784","billingAmount":"11","mcc":"5999","country":"UAE","city":"Dubai","merchantName":"FIRST THIRD BANK","cardExpiryDate":"2710"}}}}

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "AuthTransaction",
    "timestamp": "2022-11-09T11:00:03Z",
    "details": {
        "transaction": {
            "type": "Auth",
            "retrievalReferenceNumber": "M3150100CL8M",
            "date": "20221111",
            "time": "141344",
            "currency": "784",
            "amount": "11",
            "authCode": "705119",
            "originator": {
                "merchantId": "123456789000000",
                "terminalId": "98765432"
            },
            "recipient": {
                "maskedCardNumber": "5XXXXXXXXXXXXXX7",
                "externalCardId": "55555555555555555557"
            },
            "status": {
                "status": "successful",
                "code": "001"
            },
            "request": {
                "transactionType": "01",
                "systemTraceAuditNumber": "037961",
                "originalAmount": "",
                "billingCurrency": "784",
                "billingAmount": "11",
                "mcc": "5999",
                "country": "UAE",
                "city": "Dubai",
                "merchantName": "FIRST THIRD BANK",
                "cardExpiryDate": "2710"
            }
        }
    }
}

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

Node Type			Type	Length	Description
id			string	36	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":"AuthTransaction","timestamp":"2020-07-20T06:49:02.366Z","response":{"status":{"code":"00","description":"successful"}}}

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

Code	Description
200	Sample Description
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error
502	Bad gateway
503	Scheduled Maintenance
504	Gateway Timeout
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)

Authorization Transaction

Status:

Production

Version:

V2

Category:

Webhook

Overview

How It Works

Authorization Transaction

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