Onramp to Merchant Deposit
Create Order
POST https://api-ramp-deposit.nivapay.com/merchant/sdk/on-ramp/order
To generate a new order
Headers
X-API-KEY*
string
Merchant API key
Request Body
order_fiat_symbol*
string
Symbol of the fiat currency in which the user would like to make payment
merchant_id*
string
ID assigned to the merchant by Nivapay
convert_to_crypto_contractAddress
string
If the virtual asset is an ERC20 / BEP20 token then it’s contract address to uniquely identify it
convert_to_crypto_network*
string
Blockchain network on which this virtual asset exists
convert_to_crypto_symbol*
string
Symbol of the virtual asset to which the fiat should be converted. Typically this is also the asset which the merchant is willing to accept.
order_fiat_amount*
string
Amount of the fiat which user would like to convert to virtual assets
user_email_id
string (email)
Email ID of your user
merchant_webhook_url
string (url)
If provided, this overrides the webhook URL configured at the time of onboarding
merchant_redirect_url*
string (url)
URL to which the user will be redirected to at the end of the journey or when user cancels the session
merchant_txn_id
string
Internal ID provided by the merchant for this order
merchant_user_id*
string
Internal ID provided by the merchant for its user during order creation
user_addressLine1
string
User’s residential address (line 1) as per their identity document
user_dob
string
User’s date of birth in yyyy-mm-dd format
user_mobileNumber
string
Mobile number with ISD code prefixed e.g. +919876543210
user_last_name
string
Last name of your user
user_first_name
string
First name of your user
user_city
string
User’s residential city as per their identity document
user_addressLine2
string
User’s residential address (line 2) as per their identity document
user_countryCode
string
ISO alpha2 code of the user’s residential country as per their identity document e.g. US, GB, etc.
user_postCode
string
User’s residential postal / zip code as per their identity document e.g. 90001
user_state
string
User’s residential state as per their identity document
fiat_payment_method
string (enum)
The payment method through which the fiat will be paid. When passed the fiat -> crpyto conversion quotes screen is not shown to the user.
Get Fiat currencies
GET https://api-ramp-deposit.nivapay.com/merchant/sdk/onramp-to-deposit/fiatCurrencies
Returns the list of fiat currencies along with the payment methods supported for on-ramping
Headers
X-API-KEY*
string
Merchant API key
Last updated