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. PRODUCTS
  2. Onramp to Merchant Deposit

How to integrate

PreviousOnramp to Merchant DepositNextNFT Checkout

Last updated 1 year ago

Was this helpful?

Go through the to know about the endpoints to integrate. This page talks about certain request parameters and the values they take.

Generating a new order

One needs to call the endpoint to generate a new order and redirect the user to the hosted checkout URL to complete the journey. If you are integrating with our , then you don't need to redirect your user. Instead a widget will open on top of your website and the user can engage with it until they complete the journey and close that widget.

Refer to the section to know the appropriate values for order_fiat_symbol, fiat_payment_method, convert_to_crypto_symbol, convert_to_crypto_network and convert_to_crypto_contractAddress params.

Customization Parameters

There are two variations possible in the user journey by using fiat_payment_method as the customization param, as explained below.

Option 1: You already know the user's payment method or want to force it to a particular payment method. Then you can pass the desired value in fiat_payment_method along with order_fiat_symbol and order_fiat_amount in the endpoint. You need to ensure that order_fiat_amount falls within the min and max amounts for the chosen order_fiat_symbol and fiat_payment_method combination. These min and max amounts are part of the the response.

If fiat_payment_method is passed, then in the user's journey, the screen will be skipped.

Typically merchants create the below widget on their platform to capture user's preferences and determine appropriate values of above params. The dropdowns below and validation of the amount can be powered by the response.

Option 2: You don't know the payment method with which user wants to make the payment. Then you can just pass the appropriate values for order_fiat_symbol and order_fiat_amount and skip the optional param fiat_payment_method. Just ensure that order_fiat_amount is within the limits prescribed in the table below.

order_fiat_symbol
name
min amount
max amount

EUR

Euro

5

60000

GBP

Great Britain Pound

4

50000

USD

United States Dollar

5

3000

AUD

Australian Dollar

8

9000

BRL

Brazilian Real

25

25000

User session validity

The hosted checkout URL when accessed by the user, generates a session for that order. The user can interact with the payment gateway screens to complete the journey during that session. However, once that session is closed or interrupted, it cannot be accessed again due to security reasons. A new order is required to be created to reattempt the transaction. In case the user has already made the payment, then they should wait for at least 2 hours and receive the final status update through email.

💡
API documentation
Web SDK
Currency Coverage
Fiat to crypto conversion quotes
Create Order
Create Order
Get Fiat Currencies
Get Fiat Currencies