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

Introduction to webhooks

Webhooks provide a powerful way to keep you aware of what's happening in your card program. Webhooks notifications are triggered by the nCore platform to notify about the different activities happening outside of your system, such as a card status change, a card transaction at a point-of-sale (POS) terminal, etc.

For example, when a card is activated, a webhook notification is sent with details of the card status update from “card not active” to “a card is active” status to the preconfigured endpoint. To receive and process these notifications, you are required to configure a webhook endpoint in your environment.

Webhooks are HTTPS requests sent from the nCore platform to your system as HTTPS POST requests. These requests contain JSON formatted information about the event and it is sent to a pre-configured receiving endpoint hosted on your system.

Essential uses

Following are the primary uses of webhooks notifications.

  • Financial record tracking: It can be used as a financial activity tracker, for example, load funds, transfers from one account to another account, etc.

  • Non-financial record tracking: It can be used as a non-financial activity tracker, for example, KYC verification and card lifecycle.

PreviousWebhooksNextnCore webhook events

Last updated 9 months ago

Was this helpful?