Buy Ramp

This endpoint can be used to intiate an NGNC On-ramp transaction.

Initiate a Buy Transaction

Use this endpoint to perform a buy transaction. POST api.ngnc.online/transactions/v1/onramp

Shell

curl --request POST \
     --url https://api.ngnc.online/transactions/v1/onramp \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'ngnc-sec-key: NGNC_SECRET_KEY' \
     --data '
{
    "business_id": "string",
    "link_tag": "string",
    "type": "string",
    "amount": 0, 
    "vendor_number": "string",
    "vendor_name": "string",
    "vendor_bank": "string",
    "account_number": "string",
    "bank_name": "string",
    "network": "string",
    "wallet_address": "string"
}'

JavaScript

Python

Parameter	Type	Description	Required
business_id	String	Buinesses unique ID which can be found on the dashboard at app.ngnc.online.	True
link_tag	String	Your business link_tag. Also provided on your dashbaord.	True
type	String	buy_ramp	True
amount	String	Amount user wishes to onramp and meant to send to vendor. (Min ₦15000)	True
vendor_name Vendor_bank Vendor_number	String	Use the List Vendors ENDPOINT to fetch the list of supported payment vendors	True
network	String	Our supported networks are (Stellar, Polygon, Solana, Avalanche)	False
wallet_address	String	Wallet address where the on-ramp stablecoin token will be sent to.	False
bank_name	String	Proof of payment Bank used to send money to the vendor account	True
account_number	String	Proof of payment Account number of bank used to send money to the vendor account.	True

// Sample Buy Request in Javascript

const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'ngnc-sec-key': 'NGNC_SECRET_KEY',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    "business_id": "8a90we32394kds3204",
    "link_tag": "Link_Eng",
    "type": "buy_ramp",
    "amount": 1000, 
    "reference": "478939302",
    "vendor_number": "028374332",
    "vendor_name": "John Doe",
    "vendor_bank": "Wema bank",
    "account_number": "303828284",
    "bank_name": "Wema bank",
    "network": "solana",
    "wallet_address": "8ajjPhDqJFWGKAQdagWUQL6YmR4BabKAqixM1AhhT"
  });
};

fetch('https://api.ngnc.online/transactions/v1/onramp', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

On Ramp NGNC

POST https://api.ngnc.online/transactions/v1/onramp

Headers

Name	Type	Description
ngnc-sec-key*	String	Get Key from Bridge App

Request Body

Name	Type	Description
business_id*	String	Get your business id from Bridge App
account_name*	String
link_tag*	String
amount*	Number
type*	String	use: buy_ramp
wallet_address*	String
network*	String
bank_name*	String
account_number*	String
vendor_bank*	String
vendor_number*	String
vendor_name*	String

200: OK Returns the successful transaction data

{
    "status": "success",
    "message": "Transaction Request successful",
    "transaction": {
        "transaction_id": "645c329afc3ac414bf70f9a1",
        "business": {
            "business_id": "0123456789"
        },
        "type": "Buy",
        "reference": "0984938271",
        "amount": 25639.55,
        "link_account_name": "Okemdinachi Nwaejie",
        "link_account_number": "8180789670",
        "link_bank_name": "Wema Bank",
        "account_number": "3338900202",
        "bank_name": "Providus Bank",
        "link_tag": "Link_eng",
        "network": "Avalanche",
        "wallet_address": "x.fie9383jEU8394jdnc",
        "date_created": "May 11, 2023"
    }
}

401: Unauthorized This happens when you enter a wrong key

404: Not Found This happens when you you use a wrong or broken url