Create Offramps Quote
https://sandboxapi.bitnob.co/api/v1/payouts/quotes (opens in a new tab)
Body Parameters
| Parameter | Type | Required | Description | Allowed Values |
|---|---|---|---|---|
| source | enum | ✅ | Source type for the off-ramp | offchain (from wallet)onchain (generate onchain wallet) |
| fromAsset | enum | ✅ | Asset type to convert from | usdtusdcbtc |
| toCurrency | enum | ✅ | Currency to convert to | Currently supported fiat:NGN (Nigerian Naira)KES (Kenyan Shilling)AUD (Australian Dollar) |
| chain | enum | ❌ | Blockchain network (optional) | lightningmainnettrc20erc20 |
| amount | number | ✅ | Amount to convert (should be in the lowest denomination, in this case cents) | - |
| settlementAmount | number | ✅ | Settlement amount after conversion | - |
Note: One of either amount or settlement amount should be provided and in the case where both are provided the amount takes priority.
Request
Offramps/Create Quote [POST]
curl --request POST \
--url https://sandboxapi.bitnob.co/api/v1/payouts/quotes \
--header 'Authorization: Bearer API-KEY' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"source": "onchain",
"fromAsset": "usdt",
"toCurrency": "ngn",
"chain": "trc20",
"amount":20000
}'Responses
🟢 200 - Result example
{
"status": true,
"message": "OffRamp quote generated successfully",
"data": {
"id": "c7a75b9f-083c-4d8e-9382-539e9537b159",
"status": "quote",
"settlementCurrency": "NGN",
"exchangeRate": 1636.01,
"quoteId": "QT_6157",
"settlementAmount": 327202,
"amount": 200,
"expiryTimeStamp": 1736949856,
"expiresInText": "This quote expires in 15 minutes",
"quoteText": "NGN 327,202 will be settled for this transaction"
}
}