Skip to main content
POST
/
onramp
Initiate Onramp
curl --request POST \
  --url https://api.linkio.world/transactions/v2/onramp \
  --header 'Content-Type: application/json' \
  --header 'ngnc-sec-key: <api-key>' \
  --data '
{
  "currency": "NGN",
  "amount": "<string>",
  "stables": "USDC",
  "vendor_bank": "<string>",
  "vendor_number": "<string>",
  "vendor_name": "<string>",
  "wallet_address": "<string>",
  "network": "<string>",
  "bank_name": "<string>",
  "account_number": "<string>",
  "routing_number": "<string>",
  "bank_address": "<string>",
  "developer_fee": false
}
'
"{\n    \"status\": \"success\",\n    \"message\": \"Transaction Request successful\",\n    \"transaction\": {\n        \"transaction_id\": \"645c329afc3ac414bf70f9a1\",\n        \"business\": {\n            \"business_id\": \"0123456789\"\n        },\n        \"type\": \"Buy\",\n        \"reference\": \"0984938271\",\n        \"amount\": 25639.55,\n        \"link_account_name\": \"Okemdinachi Nwaejie\",\n        \"link_account_number\": \"8180789670\",\n        \"link_bank_name\": \"Wema Bank\",\n        \"account_number\": \"3338900202\",\n        \"bank_name\": \"Providus Bank\",\n        \"link_tag\": \"Link_eng\",\n        \"network\": \"Avalanche\",\n        \"wallet_address\": \"x.fie9383jEU8394jdnc\",\n        \"date_created\": \"May 11, 2023\"\n    }\n}"

Authorizations

ngnc-sec-key
string
header
default:""
required

Body

application/json
currency
enum<string>
default:NGN
required

Currency in which user wants to pay for onramp asset. (NGN, USD)

Available options:
NGN,
USD
amount
string
required

Amount user wishes to onramp based on currency selected. (Min ~ 15K NGN, 20USD)

stables
enum<string>
required

Stable coin in which user wants to be settle in.(USDC, USDT)

Available options:
USDC,
USDT
vendor_bank
string

Use the "Fetch Payment Vendors" ENDPOINT to fetch the list of supported payment vendors

vendor_number
string

Use the "Fetch Payment Vendors" ENDPOINT.

vendor_name
string

Use the "Fetch Payment Vendors" ENDPOINT.

wallet_address
string

Wallet address where the on-ramp stablecoin token will be sent to.

network
string

The address network to disburse payment. Our supported networks are (Wallet address network. Our supported networks are (Arbitrum, Avalanche, Stellar, Base, Polygon, Solana, Stellar, Tron, XRPL).

bank_name
string

Proof of payment Bank used to send money to the vendor account

account_number
string

Proof of payment Account number of bank used to send money to the vendor account.

routing_number
string

Proof of payment Bank Routing number used to send money to the vendor account

bank_address
string

Optional for transactions that provide bank transaction address

developer_fee
boolean
default:false

Businesses that wish to charge a certain percentage on your their users for each transaction made.

Response

200

status
string
Example:

"success"

message
string
Example:

"Transaction Request successful"

transaction
object