Skip to main content
POST
/
quote
/
onramp
Get quote
curl --request POST \
  --url https://processor-prod.up.railway.app/quote/onramp \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: <api-key>' \
  --data '
{
  "amount": 10000,
  "currency": "NGN",
  "asset": "base:usdc",
  "is_exact_output": false
}
'
{
  "success": true,
  "status": 200,
  "message": "Onramp quote fetched successfully",
  "timestamp": "2025-09-09T23:00:02.682Z",
  "data": {
    "type": "onramp",
    "fee": 0,
    "expiry": "2025-09-09T23:02:02.682Z",
    "currency": "NGN",
    "rate": 1521,
    "input_amount": 10000,
    "output_amount": 6.574621959237344
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.bread.africa/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-service-key
string
header
required

Body

application/json
​
amount
number
required

The fiat amount to to deposit for onramp

Example:

10000

​
currency
enum<string>
required

The fiat currency to deposit for onramp

Available options:
NGN
Example:

"NGN"

​
asset
enum<string>
required

The crypto asset to receive after onramp

Available options:
ethereum:usdc,
base:usdc,
arbitrum:usdc,
solana:usdc,
bsc:usdc,
polygon:usdc,
optimism:usdc,
avalanche:usdc,
ethereum:usdt,
arbitrum:usdt,
solana:usdt,
polygon:usdt,
bsc:usdt,
optimism:usdt,
avalanche:usdt,
base:cngn,
bsc:cngn
Example:

"base:usdc"

​
is_exact_output
boolean
default:false

Whether the amount specified is the exact output amount in crypto asset

Example:

false

Response

200 - application/json

Onramp quote fetched successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Onramp quote fetched successfully"

​
timestamp
string<date-time>
Example:

"2025-09-09T23:00:02.682Z"

​
data
object