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

Token Notification

Status:

Production

Version:

V2

Product:

Webhook Solutions

Overview

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

/V2/webhook/TokenNotification

Token Notification

Download

Status:

Production

Version:

V2

Product:

Webhook Solutions
/V2/webhook/TokenNotification
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
idstring36Unique identifer for the request
typestring5AC: Activation,TC: Completion,TD: Token Events,TE: Token Resume
timestampstring30Timestamp of the request - Format YYYY-MM-DDtHH:MM:SS.SSS+04:00
detailscardidvaluestring32Card Identifier
typestring20externalCardId - when this is used,cardNumber - when clear card number is used
maskedCardNumberstring19Masked PAN number
clientIdstring20Client ID
mobilePhonestring32Mobile Number to which the SMS should be triggered
emailstring255Email ID
languagestring3Language ISO code
cbsNumberstring10CBS Number
textMessagestring255The content of the SMS
tokenactivationPrefstring10Activation Preference. Applicable for type= AC
requestorIdstring10Token Requestor ID
requestorNamestring30Wallet Name
activationCodestring30Activation OTP. Applicable for type= AC
deviceTypestring10Device Type. Applicable for type= TC, TD, TE
tokenEventReasonCodestring20TOKEN STATUS. Applicable for type= TD, TE
tokenEventIndicatorstring33:Inactive/Deactivated 4:SoftDeleted 6:Suspended 7:Active. Applicable for type= TD, TE

{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "AC",
    "timestamp": "2020-07-20T06:49:02.366Z",
    "details": {
        "card": {
            "id": {
                "value": "99984100133767425304",
                "type": "externalCardId"
            },
            "maskedCardNumber": "999841XXXXXX7408",
            "clientId": "112233677339066180",
            "mobilePhone": "112211223322",
            "email": "James.Robert@network.global",
            "language": "ENG",
            "cbsNumber": "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.",
        "token": {
            "activationPref": "1",
            "requestorId": "50110030273",
            "requestorName": "APPLE PAY",
            "activationCode": "303241",
            "deviceType": "21",
            "tokenEventReasonCode": "Active",
            "tokenEventIndicator": "3,4,6,7"
        }
    }
}

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

Node TypeTypeLengthDescription
idstring36Unique identifer ID
typestring10AC: Activation,TC: Completion,TD: Token Events,TE: Token Resume
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": "AC",
    "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