Nivapay - Product & API Documentation
  • 📖Introduction
    • 🚀What is Nivapay?
    • 🏂Onboarding Process
  • 💡PRODUCTS
    • Onramp to Merchant Deposit
      • How to integrate
    • NFT Checkout
      • How to integrate
    • NFT Minting
      • How to integrate
    • 💸Currency Coverage
    • ⏯️Test Credentials for Sandbox
    • 📒Registering your Smart Contract
  • 🔗Integrations
    • ☁️Environments
    • 🔑Authentication
    • #️⃣API response codes
    • 📦Web SDK (ReactJS)
  • ⚙️API Documentation
    • Onramp to Merchant Deposit
    • NFT Checkout
    • NFT Minting
  • 🌐Webhooks
    • Overview
    • Onramp to Merchant Deposit
    • NFT Checkout
    • NFT Minting
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks

NFT Minting

List of events

Event
Description

order.created

This event is sent by default to all the newly generated orders

order.deposit.processing

When the user has triggered a transaction (or clicked “I have Paid”)

order.deposit.success

Whenever an inbound transaction is received on the destination wallet. If multiple transactions are detected, events will be sent for each confirmed transaction.

order.deposit.failure

After the user has triggered the transaction, if no inbound transaction is detected within the shown ETA, this event is sent

order.smartcontract.processing

When virtual asset funds are being used to execute the smart contract

order.smartcontract.success

When the smart contract execution is successfully completed and confirmed on blockchain

order.smartcontract.failure

When the smart contract execution could not happen due to any reason, then it fails

order.success

This additional webhook event will be sent to represent the overall success of the journey

user.widget.open

Whenever the front-end screen is accessed by the user for the first time, this event is dispatched. In case multiple such events are received for a particular order, only the first one should be considered as the truth.

user.widget.close

Whenever user closes the front-end screen this event is sent. This event’s dispatch cannot be guaranteed and will be shared on a best-efforts basis. Due to certain technical constraints, it is difficult to detect closure of a front-end screen.

Context structure for event order.created

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

crypto_symbol

Symbol of the virtual asset to be paid

crypto_network

Blockchain network of this virtual asset

crypto_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

crypto_amount

Virtual asset amount to be paid to fulfil this order

smart_contract_function_id

ID of the SC function to be called

smart_contract_network

Blockchain network of this smart contract

Context structure for events order.deposit.processing and order.deposit.failure

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

crypto_symbol

Symbol of the virtual asset expected to be received

crypto_network

Blockchain network of this virtual asset

crypto_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

crypto_amount_expected

Virtual asset amount expected to be received

Context structure for event order.deposit.success

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

transaction_hash

Blockchain hash of the transaction

transaction_hash_url

Block explorer URL corresponding to this txn hash

crypto_symbol

Symbol of the virtual asset received

crypto_network

Blockchain network of this virtual asset

crypto_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

crypto_amount_received

Virtual asset amount received

crypto_service_fee

Service fee deducted

crypto_network_fee

Network fee deducted

crypto_amount_credited

Net amount credited after fee deduction

Context structure for event order.smartcontract.processing

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

smart_contract_function_id

ID of the SC function to be called

smart_contract_network

Blockchain network of this smart contract

issued_token_symbol

Symbol of the virtual asset being issued by the smart contract

issued_token_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

issued_token_amount

Virtual asset amount being issued by the smart contract

Context structure for event order.smartcontract.failure

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

smart_contract_function_id

ID of the SC function called

smart_contract_network

Blockchain network of this smart contract

transaction_hash

Blockchain hash of the failed transaction (if available)

transaction_hash_url

Block explorer URL corresponding to this txn hash (if available)

message

Message (if available) describing the reason for transaction failure

Context structure for event order.smartcontract.success

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

smart_contract_function_id

ID of the SC function called

smart_contract_network

Blockchain network of this smart contract

issued_token_symbol

Symbol of the virtual asset issued by the smart contract

issued_token_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

issued_token_amount

Virtual asset amount issued by the smart contract

transaction_hash

Blockchain hash of the transaction

transaction_hash_url

Block explorer URL corresponding to this txn hash

Context structure for event order.success

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

crypto_symbol

Symbol of the virtual asset paid

crypto_network

Blockchain network of this virtual asset

crypto_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

crypto_amount_received

Virtual asset amount received

smart_contract_function_id

ID of the SC function called

smart_contract_network

Blockchain network of this smart contract

issued_token_symbol

Symbol of the virtual asset issued by the smart contract

issued_token_contract_address

Contract address if this virtual asset is a token (ERC20, BEP20, ERC721, etc.)

issued_token_amount

Virtual asset amount issued by the smart contract

transaction_hash

Blockchain hash of the transaction

transaction_hash_url

Block explorer URL corresponding to this txn hash

Context structure for events user.widget.open and user.widget.close

Event
Description
required

order_id

Order ID generated by Nivapay

merchant_user_id

Merchant assigned user ID during order creation

merchant_txn_id

Merchant assigned order ID during order creation

PreviousNFT Checkout

Last updated 1 year ago

Was this helpful?

🌐