Onramp to Merchant Deposit

Create Order

POST https://api-ramp-deposit.nivapay.com/merchant/sdk/on-ramp/order

To generate a new order

Headers

Name
Type
Description

X-API-KEY*

string

Merchant API key

Request Body

Name
Type
Description

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.

param
type
description
required

order_id

string

Order ID assigned by Nivapay

yes

hash

string

Secret hash which allows you to access the gateway_url. It is already added as a query param to the gateway_url.

yes

gateway_url

string (url)

URL to the hosted checkout page where you need to redirect your user

yes

Create Order request example (curl)
curl --location 'https://api-ramp.nivapay.com/merchant/sdk/on-ramp/order' \
--header 'Content-Type: application/json' \
--header 'x-api-key: 2b03fc9e-550e-4ffb-9136-92b627f9988b' \
--data-raw '{
    "order_fiat_amount": "50",
    "order_fiat_symbol": "GBP",
    "convert_to_crypto_symbol": "USDT",
    "convert_to_crypto_network": "Ethereum",
    "convert_to_crypto_contractAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7",

    "merchant_id": "M7184835",
    "merchant_user_id": "1xdeavy",
    "merchant_txn_id": "3589cb4a-0830-497d-a92d-c5178eb2ab9f",
    "merchant_redirect_url": "https://nivapay.com",
    "merchant_webhook_url": "https://hooks.nivapay.com/payment-services/",

    "user_email_id": "daves@yahoo.com",
    "user_first_name": "Dave",
    "user_last_name": "Smith",
    "user_mobileNumber": "+12025550164",
    "user_dob": "1994-08-26",
    "user_addressLine1": "2819 Brannon Street",
    "user_addressLine2": "",
    "user_city": "Los Angeles",
    "user_state": "California",
    "user_postCode": "90001",
    "user_countryCode": "US"
}'

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

Name
Type
Description

X-API-KEY*

string

Merchant API key

param
type
description
required

currencies

json array

Array containing the list of active fiat currencies

yes

symbol

string

ISO symbol of the fiat currency

yes

name

string

Name of the fiat currency

yes

supportedCountries

string array

List of countries supporting this currency. Values are in ISO alpha2 country codes.

yes

paymentOptions

json array

Array containing the list of active payment methods

yes

name

string

Name of the payment method available for this fiat

yes

id

string (enum)

Unique Code of the payment method

yes

icon

string (url)

Display icon for this payment method

yes

maxAmount

number (int)

Max amount which can be paid through this payment method for this fiat

yes

minAmount

number (int)

Min amount which can be paid through this payment method for this fiat

yes

PreviousWeb SDK (ReactJS)NextNFT Checkout

Last updated

Was this helpful?