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 Result(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

Account Transfer Result

Status:

Production

Version:

V2

Category:

Webhook

Overview

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

How It Works

The account transfer (product transfer) API request operates in asynchronous mode, meaning the request is submitted but processed later by a back-end scheduler. To keep your system informed of the transfer status, this webhook is set up to provide updates on the request status.

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	accountTransfer	mainApplication	regNumber		string	64	Application unique identifier
			creationType		string	32	Additional application creation type code. {API_ASYNC, API_SYNC, FILE, SCREEN} for {Online API with delayed processing, Online API with instant processing, Batch file, Screen}.
			responseCode		string	9	Error code
			responseClass		string	32	Information, Warning, Error, Fatal Erro
			responseMessage		string	255	Status description
			sourceAppCode		string	32	Account Role
			sourceAppName		string	32	Respective parameter passed when the application was submitted from API/Batch
			externalUserId		string	32	Respective parameter passed when the application was submitted from API/Batch
		account	id	value	string	32	CONTRACT_NUMBER value
			id	type	string	20	accountNumber fixed value
			role		string	20	Account Role
			cbsNumber		string	64	Respective field of the contract record. Normally used for referring the account related to this contract in the core banking system.
			productCode		string	32	Code of the product assigned to the contract. Values depend on the Way4 configuration
			productGroup		string	32	Product group. Values depend on the Way4 configuration
		cards	applicationregNumber		string	100	This is a unique identifier for the request
			role		string	50	Creation type, for example the request was created from screen
			clientId		string	10	Response code where 0 is successful
			new	maskedCardNumber	string	64	PAN. Is masked when PAN masking is requested
				externalCardId	string	20	EXID
				productCode	string	32	New product code
			old	maskedCardNumber	string	64	PAN. Is masked when PAN masking is requested
				externalCardId	string	20	EXID
				productCode	string	32	Old product code

{"id":"b876d568-8411-4638-bdef-a1a188a4773b","type":"AccountTransferResult","timestamp":"2020-07-20T06:49:02.366Z","details":{"accountTransfer":{"mainApplication":{"regNumber":"50165654023572","creationType":"SCREEN","responseCode":"0","responseClass":"Information","responseMessage":"Adv Application Accept action completed successfully","sourceAppCode":"src_app_code","sourceAppName":"src_app_name","externalUserId":"ext_user_id"},"account":{"id":{"value":"0009998410098839208","type":"accountNumber"},"role":"ACC_MAIN","cbsNumber":"7980876890876789","productCode":"982_AED_017_A","productGroup":"ISSCREDIT"},"cards":[{"applicationregNumber":"356364128929","role":"MAIN_CARD","clientId":"112233135637995299","new":{"maskedCardNumber":"999851******6844","externalCardId":"99985101174564327927","productCode":"982_AED_017_P"},"old":{"maskedCardNumber":"999851******6844","externalCardId":"99985101174564327927","productCode":"982_AED_016_P"}}]}}}

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "AccountTransferResult",
    "timestamp": "2020-07-20T06:49:02.366Z",
    "details": {
        "accountTransfer": {
            "mainApplication": {
                "regNumber": "50165654023572",
                "creationType": "SCREEN",
                "responseCode": "0",
                "responseClass": "Information",
                "responseMessage": "Adv Application Accept action completed successfully",
                "sourceAppCode": "src_app_code",
                "sourceAppName": "src_app_name",
                "externalUserId": "ext_user_id"
            },
            "account": {
                "id": {
                    "value": "0009998410098839208",
                    "type": "accountNumber"
                },
                "role": "ACC_MAIN",
                "cbsNumber": "7980876890876789",
                "productCode": "982_AED_017_A",
                "productGroup": "ISSCREDIT"
            },
            "cards": [
                {
                    "applicationregNumber": "356364128929",
                    "role": "MAIN_CARD",
                    "clientId": "112233135637995299",
                    "new": {
                        "maskedCardNumber": "999851******6844",
                        "externalCardId": "99985101174564327927",
                        "productCode": "982_AED_017_P"
                    },
                    "old": {
                        "maskedCardNumber": "999851******6844",
                        "externalCardId": "99985101174564327927",
                        "productCode": "982_AED_016_P"
                    }
                }
            ]
        }
    }
}

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":"AccountTransferResult","timestamp":"2020-07-20T06:49:02.366Z","response":{"status":{"code":"00","description":"successful"}}}

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "AccountTransferResult",
    "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 Result(Post)

Account Status Change(Post)

Card Status Change(Post)

Token Notification(Post)

Account Transfer Result

Status:

Production

Version:

V2

Category:

Webhook

Overview

How It Works

Account Transfer Result

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