Webhook Solutions

Webhook Solutions

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.

Integration

Our Webhooks solution relies on consumer defining a single API endpoint to receive all the notification types. Each message contains a common structure with:

  • id: Unique message id
  • type: type of notification. This is the key field to differentiate processing of the details payload
  • timestamp: timestamp of the message from NI systems
  • details: notification payload. Every message type will have its own payload specification and should be parsed and acted accordingly.

 

Security

The webhook endpoint is expected to be hosted through TLS/HTTPS to ensure secured data exchange. In addition to this, our webhook solution supports API authentication.
The preferred authentication strategy is oAuth2 where the consumer should provide NI with:

  • Authentication/Token management URL endpoint
  • client_id
  • client_secret

 

Pre-requisites

Our webhook API request will be using the POST verb.
To register a Webhook endpoint with us, please contact your relationship manager with:

  • Webhook URL Endpoint
  • Authentication mode
  • Security requirements
NI will ensure efficient management of authentication token and will include such in every webhook call.
To support different authentication method or integration strategy with us, please contact your relationship manager

 

 

 
Download
Version
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
Product : Webhook Solutions
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
Product : Webhook Solutions
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
Product : Webhook Solutions
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
Product : Webhook Solutions
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
Product : Webhook Solutions
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
Product : Webhook Solutions
Try Out   
Authorization Transaction(Post)

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

Status :Production
Version :V2
Product : Webhook Solutions
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
Product : Webhook Solutions
Try Out   
Account Status Change(Post)

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

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

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

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

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

Status :Production
Version :V2
Product : Webhook Solutions
Try Out   

Account Transfer Result

Status:

Production

Version:

V2

Product:

Webhook Solutions

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.

/V2/webhook/AccountTransferResult

Account Transfer Result

Download

Status:

Production

Version:

V2

Product:

Webhook Solutions
/V2/webhook/AccountTransferResult
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
idstring20Unique identifer for the request
typestring32Type of the webhook
timestampstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
detailsaccountTransfermainApplicationregNumberstring64Application unique identifier
creationTypestring32Additional application creation type code. {API_ASYNC, API_SYNC, FILE, SCREEN} for {Online API with delayed processing, Online API with instant processing, Batch file, Screen}.
responseCodestring9Error code
responseClassstring32Information, Warning, Error, Fatal Erro
responseMessagestring255Status description
sourceAppCodestring32Account Role
sourceAppNamestring32Respective parameter passed when the application was submitted from API/Batch
externalUserIdstring32Respective parameter passed when the application was submitted from API/Batch
accountidvaluestring32CONTRACT_NUMBER value
typestring20accountNumber fixed value
rolestring20Account Role
cbsNumberstring64Respective field of the contract record. Normally used for referring the account related to this contract in the core banking system.
productCodestring32Code of the product assigned to the contract. Values depend on the Way4 configuration
productGroupstring32Product group. Values depend on the Way4 configuration
cardsapplicationregNumberstring100This is a unique identifier for the request
rolestring50Creation type, for example the request was created from screen
clientIdstring10Response code where 0 is successful
newmaskedCardNumberstring64PAN. Is masked when PAN masking is requested
externalCardIdstring20EXID
productCodestring32New product code
oldmaskedCardNumberstring64PAN. Is masked when PAN masking is requested
externalCardIdstring20EXID
productCodestring32Old 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"
                    }
                }
            ]
        }
    }
}

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

Node TypeTypeLengthDescription
idstring36Unique identifer ID
typestring10Type of the webhook
timestampstring30Timestamp of the response - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
responsestatuscodestring5Status code of the response
descriptionstring30Response Description

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

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