Initiate
curl --request POST \
--url https://api.onswitch.xyz/onramp/initiate \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"amount": 150050,
"country": "NG",
"currency": "NGN",
"asset": "base:usdc",
"beneficiary": {
"holder_type": "INDIVIDUAL",
"holder_name": "Chinonso Adeyemi",
"wallet_address": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
},
"exact_output": false,
"callback_url": "https://your-app.com/webhook",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"channel": "BANK",
"developer_fee": 0.5,
"developer_recipient": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
}
'import requests
url = "https://api.onswitch.xyz/onramp/initiate"
payload = {
"amount": 150050,
"country": "NG",
"currency": "NGN",
"asset": "base:usdc",
"beneficiary": {
"holder_type": "INDIVIDUAL",
"holder_name": "Chinonso Adeyemi",
"wallet_address": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
},
"exact_output": False,
"callback_url": "https://your-app.com/webhook",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"channel": "BANK",
"developer_fee": 0.5,
"developer_recipient": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 150050,
country: 'NG',
currency: 'NGN',
asset: 'base:usdc',
beneficiary: {
holder_type: 'INDIVIDUAL',
holder_name: 'Chinonso Adeyemi',
wallet_address: '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
},
exact_output: false,
callback_url: 'https://your-app.com/webhook',
reference: 'a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90',
channel: 'BANK',
developer_fee: 0.5,
developer_recipient: '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
})
};
fetch('https://api.onswitch.xyz/onramp/initiate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onswitch.xyz/onramp/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 150050,
'country' => 'NG',
'currency' => 'NGN',
'asset' => 'base:usdc',
'beneficiary' => [
'holder_type' => 'INDIVIDUAL',
'holder_name' => 'Chinonso Adeyemi',
'wallet_address' => '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
],
'exact_output' => false,
'callback_url' => 'https://your-app.com/webhook',
'reference' => 'a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90',
'channel' => 'BANK',
'developer_fee' => 0.5,
'developer_recipient' => '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.onswitch.xyz/onramp/initiate"
payload := strings.NewReader("{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.onswitch.xyz/onramp/initiate")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/onramp/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Onramp initiated successfully",
"timestamp": "2026-04-23T14:41:52.183Z",
"data": {
"status": "AWAITING_DEPOSIT",
"type": "ONRAMP",
"reference": "8f82e3fe-a881-4182-8af0-7cb36d9dd858",
"beneficiary": "69ea2fb0d4a6a8e1d4600027",
"rate": 1396.176,
"developer_fee": {
"amount": 0,
"amount_usd": 0,
"currency": "USDC",
"network": "BASE"
},
"source": {
"amount": 2000,
"amount_usd": 1.432484,
"network": "FIAT",
"currency": "NGN"
},
"destination": {
"amount": 1.432484,
"amount_usd": 1.432484,
"network": "BASE",
"currency": "USDC"
},
"deposit": {
"amount": 2000,
"expires_at": "2026-04-23T15:11:52.180Z",
"account_number": "6022671694",
"account_name": "Switchlabsltd Checkout",
"bank_code": "090286",
"bank_name": "Safehaven Microfinance Bank",
"asset": "base:usdc",
"note": [
"Kindly send the exact amount to the bank account to complete the transaction.",
"This dynamic bank account has a 30 minutes expiry window and can only be used once."
]
},
"meta": {},
"created_at": "2026-04-23T14:41:52.180Z",
"updated_at": "2026-04-23T14:41:52.180Z"
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}Initiate
Initiate a local currency to stablecoin transaction.
POST
/
onramp
/
initiate
Initiate
curl --request POST \
--url https://api.onswitch.xyz/onramp/initiate \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"amount": 150050,
"country": "NG",
"currency": "NGN",
"asset": "base:usdc",
"beneficiary": {
"holder_type": "INDIVIDUAL",
"holder_name": "Chinonso Adeyemi",
"wallet_address": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
},
"exact_output": false,
"callback_url": "https://your-app.com/webhook",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"channel": "BANK",
"developer_fee": 0.5,
"developer_recipient": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
}
'import requests
url = "https://api.onswitch.xyz/onramp/initiate"
payload = {
"amount": 150050,
"country": "NG",
"currency": "NGN",
"asset": "base:usdc",
"beneficiary": {
"holder_type": "INDIVIDUAL",
"holder_name": "Chinonso Adeyemi",
"wallet_address": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
},
"exact_output": False,
"callback_url": "https://your-app.com/webhook",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"channel": "BANK",
"developer_fee": 0.5,
"developer_recipient": "0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a"
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 150050,
country: 'NG',
currency: 'NGN',
asset: 'base:usdc',
beneficiary: {
holder_type: 'INDIVIDUAL',
holder_name: 'Chinonso Adeyemi',
wallet_address: '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
},
exact_output: false,
callback_url: 'https://your-app.com/webhook',
reference: 'a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90',
channel: 'BANK',
developer_fee: 0.5,
developer_recipient: '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
})
};
fetch('https://api.onswitch.xyz/onramp/initiate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onswitch.xyz/onramp/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 150050,
'country' => 'NG',
'currency' => 'NGN',
'asset' => 'base:usdc',
'beneficiary' => [
'holder_type' => 'INDIVIDUAL',
'holder_name' => 'Chinonso Adeyemi',
'wallet_address' => '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
],
'exact_output' => false,
'callback_url' => 'https://your-app.com/webhook',
'reference' => 'a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90',
'channel' => 'BANK',
'developer_fee' => 0.5,
'developer_recipient' => '0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.onswitch.xyz/onramp/initiate"
payload := strings.NewReader("{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.onswitch.xyz/onramp/initiate")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/onramp/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 150050,\n \"country\": \"NG\",\n \"currency\": \"NGN\",\n \"asset\": \"base:usdc\",\n \"beneficiary\": {\n \"holder_type\": \"INDIVIDUAL\",\n \"holder_name\": \"Chinonso Adeyemi\",\n \"wallet_address\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n },\n \"exact_output\": false,\n \"callback_url\": \"https://your-app.com/webhook\",\n \"reference\": \"a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90\",\n \"channel\": \"BANK\",\n \"developer_fee\": 0.5,\n \"developer_recipient\": \"0x8F3aC91d2B741E59f064E9053a4d2E8F1c0b6D93a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Onramp initiated successfully",
"timestamp": "2026-04-23T14:41:52.183Z",
"data": {
"status": "AWAITING_DEPOSIT",
"type": "ONRAMP",
"reference": "8f82e3fe-a881-4182-8af0-7cb36d9dd858",
"beneficiary": "69ea2fb0d4a6a8e1d4600027",
"rate": 1396.176,
"developer_fee": {
"amount": 0,
"amount_usd": 0,
"currency": "USDC",
"network": "BASE"
},
"source": {
"amount": 2000,
"amount_usd": 1.432484,
"network": "FIAT",
"currency": "NGN"
},
"destination": {
"amount": 1.432484,
"amount_usd": 1.432484,
"network": "BASE",
"currency": "USDC"
},
"deposit": {
"amount": 2000,
"expires_at": "2026-04-23T15:11:52.180Z",
"account_number": "6022671694",
"account_name": "Switchlabsltd Checkout",
"bank_code": "090286",
"bank_name": "Safehaven Microfinance Bank",
"asset": "base:usdc",
"note": [
"Kindly send the exact amount to the bank account to complete the transaction.",
"This dynamic bank account has a 30 minutes expiry window and can only be used once."
]
},
"meta": {},
"created_at": "2026-04-23T14:41:52.180Z",
"updated_at": "2026-04-23T14:41:52.180Z"
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}Authorizations
Service key for API authentication
Body
application/json
Required range:
x >= 0ISO 3166-1 alpha-2 country code.
Available options:
BJ, CD, CI, CM, ET, GA, GH, GM, GN, KE, LR, ML, MW, NG, RW, SL, SN, TZ, UG, ZA, ZM Available options:
base:usdc, solana:usdc, solana:usdt, ethereum:usdc, ethereum:usdt, polygon:usdc, polygon:usdt, bsc:usdc, bsc:usdt, arbitrum:usdc, optimism:usdc, gnosis:usdc, gnosis:usdt, arbitrum:usdt, avalanche:usdc, monad:usdc, optimism:usdt, monad:usdt, plasma:usdt, avalanche:usdt, tron:usdt, linea:usdt, mantle:usdt, hyperevm:usdt, berachain:usdt, linea:usdc, berachain:usdc, sonic:usdc, base:cngn, bsc:cngn Available options:
CDF, ETB, GHS, GMD, GNF, KES, LRD, MWK, NGN, RWF, SLE, TZS, UGX, USD, XAF, XOF, ZAR, ZMW Webhook URL to receive transaction status updates.
Transfer channel for the local-currency payment (BANK or MOBILEMONEY).
Available options:
BANK, MOBILEMONEY Optional developer fee percentage (0-100)
Required range:
0 <= x <= 100Optional wallet address to receive developer fee.
Response
Successfully initiated onramp transaction
Hide child attributes
Hide child attributes
Available options:
AWAITING_DEPOSIT, PROCESSING, COMPLETED, FAILED Available options:
OFFRAMP, ONRAMP, SWAP, WALLET ⌘I