Onramp to Merchant Deposit

List of events

Event	Description
order.created	This event is sent by default to all the newly generated orders
order.onramp.processing	When the user has completed the fiat payment or at least declared that they have initiated it
order.onramp.failure	When Nivapay fails to detect the fiat payment, or could not convert the fiat to virtual asset, or could not deposit it to the user’s wallet
order.onramp.success	User’s fiat is received, converting to virtual asset and credited to user’s wallet
order.deposit.processing	When the transfer of virtual assets from user to merchant is initiated
order.deposit.success	When the transfer of virtual assets from user to merchant is successfully completed
order.deposit.failure	When the transfer of virtual assets from user to merchant is not successful

Context structure for event order.created

Event	Description
orderId	Order ID generated by Nivapay
userRef	Internal ID provided by the merchant for its user during order creation
merchantOrderRef	Internal ID provided by the merchant for this order
fiatSymbol	Symbol of the fiat currency for this ramp order
fiatAmount	Fiat amount which will be converted to virtual asset
virtualAssetSymbol	Symbol of the virtual asset to which the fiat will be converted
virtualAssetNetwork	Blockchain network on which this virtual asset exists

Context structure for events order.onramp.processing and order.onramp.success

Event	Description
orderId	Order ID generated by Nivapay
userRef	Internal ID provided by the merchant for its user during order creation
merchantOrderRef	Internal ID provided by the merchant for this order
fiatSymbol	Symbol of the fiat currency for this ramp order
fiatAmount	Fiat amount which will be converted to virtual asset
virtualAssetSymbol	Symbol of the virtual asset to which the fiat will be converted
virtualAssetNetwork	Blockchain network on which this virtual asset exists and to which the fiat will be converted
virtualAssetAmount	Virtual asset amount to which fiat is expected to get converted to or has converted to
status	PROCESSING or COMPLETED
status_reason	Additional information, if available, on the status

Context structure for events order.onramp.failure

Event	Description
orderId	Order ID generated by Nivapay
userRef	Internal ID provided by the merchant for its user during order creation
merchantOrderRef	Internal ID provided by the merchant for this order
fiatSymbol	Symbol of the fiat currency for this ramp order
fiatAmount	Fiat amount which will be converted to virtual asset
virtualAssetSymbol	Symbol of the virtual asset to which the fiat will be converted
virtualAssetNetwork	Blockchain network on which this virtual asset exists and to which the fiat will be converted
virtualAssetAmount	Virtual asset amount to which fiat is expected to get converted to or has converted to
status	One among the following: CANCELLED: Payment is cancelled by the user EXPIRED: User didn't pay within the expiry time FAILED: Payment method not supported, payment failed, card declined, etc. REFUNDED: Payment received & refunded because order cannot be fulfilled
status_reason	Reason for the above status

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

Event	Description
orderId	Order ID generated by Nivapay
userRef	Internal ID provided by the merchant for its user during order creation
merchantOrderRef	Internal ID provided by the merchant for this order
virtualAssetSymbol	Symbol of the virtual asset being transferred
virtualAssetNetwork	Blockchain network on which this virtual asset exists
depositAmount	Amount of virtual asset being transferred from user to merchant

Context structure for event order.deposit.success

Event	Description
orderId	Order ID generated by Nivapay
userRef	Internal ID provided by the merchant for its user during order creation
merchantOrderRef	Internal ID provided by the merchant for this order
virtualAssetSymbol	Symbol of the virtual asset being transferred
virtualAssetNetwork	Blockchain network on which this virtual asset exists
depositAmount	Amount of virtual asset being transferred from user to merchant
serviceFee	Service fee applicable for this transfer
networkFee	Network fee applicable for this transfer
creditedAmount	Amount credited to the merchant after deduction of fees