LogoLogo
NymCardAPI catalogContact usnFront catalog
  • NYMCARD DOCUMENTATION
  • Get Started
    • nCore API Quick Tutorial
    • API Core Principles
    • Program management
      • Manage documents by APIs
      • User KYB process
      • Necessary parameters per user type
      • User ID verification by SDK
      • User KYC process
    • Issuance
      • Users
      • Cards
    • Issuing Physical Cards
      • Individual card issuance
      • Bulk card issuance
      • Card fulfillment
      • Card PIN management
      • Card replacement
      • Proxy number usage
    • Issuing Virtual Cards
      • Migration of virtual to physical card
    • Funding and transfers
      • Funding
      • Internal funding source
      • External funding source
        • From card
        • From bank account
        • Lean API flow
        • DAPI direct API flow
      • Transfers
      • Western Union APIs
    • Product Management
      • Card product
      • Balance limits
      • Velocity limits
      • Fees
      • Charges
      • Multi-currency
      • Authorization controls
        • Enhancements for MCC list management
    • Transactions
      • Payment ecosystem
      • Transaction lifecycle
      • Transaction types
      • Transaction endpoints scenarios
      • Multi-clearing process
    • Webhooks
      • Introduction to webhooks
      • nCore webhook events
      • Steps to configure a webhook
      • Webhooks samples
      • Webhook changes for simulation
      • Webhooks management
    • Security
      • PCI widget
      • 3D Secure
      • OTP SMS templates
    • Release announcements
      • Embedded Lending Release Notes
      • Changes in the release on 13/07/2023
      • Changes in the release on 23/05/2023
      • Changes in the release on 04/04/2023
  • For developers
    • nCore API catalog
    • nFront API catalog
Powered by GitBook
On this page

Was this helpful?

  1. Get Started
  2. Webhooks

nCore webhook events

Following are the available webhooks you can create to receive event notifications.

Event name

Event type

Send webhook notification when

Status change

CARD_STATUS_CHANGE

A card status is updated

Transaction

TRANSACTION

A transaction is performed by a card

KYC

KYC_RESULT

Changes in user’s KYC request are done

User creation

USER_CREATED

User is created

User status

USER_STATUS_CHANGE

User status is changed

User document

USER_DOCUMENT_ALERT

The document expiration date is approaching

IDV

IDENTITY_VERIFICATION

Identity verification needed

PIN change

PIN_CHANGE

PIN is changed

Auth expiry

EXPIRED_AUTH

Auth/pre-auth is expired

Charges

CHARGE_APPLIED

Charges are applied

Account status

ACCOUNT_STATUS_CHANGE

Account status is changed

Card provisioning

CARD_PROVISIONING

Card is tokenized

Token notification

TOKEN_NOTIFICATION

Digital wallet token status is updated

Card or account creation

SUCCESSFULLY_CREATED

Card or account is successfully created

Handling

Following are the methods in which nCore platform handles webhooks notifications.

  • The nCore platform maintains a retry counter and resends the failed notifications by triggering the expired webhooks.

  • It includes a Basic Auth (encoded in base64) header in the webhook notification message.

  • The nCore platform pings a configured webhook to validate the credential and connectivity.

  • To support token uniqueness, each transaction is recognized by a unique transaction token, and each webhook is identified by a unique event token.

PreviousIntroduction to webhooksNextSteps to configure a webhook

Last updated 7 months ago

Was this helpful?