Skip to main content
POST
Create an on-ramp or off-ramp quote

Authorizations

Authorization
string
header
required

A secret NorthFond business API key. Keep it on your server.

Headers

Idempotency-Key
string
required

A unique key for this logical write operation. Reuse it when retrying the exact same request.

Required string length: 8 - 255

Body

application/json
direction
any
required
beneficiary_id
string<uuid>
required
source_amount
number
required
Required range: 0.000001 <= x <= 1000000
chain
enum<string>
required
Available options:
base,
polygon,
arbitrum,
optimism,
avalanche
source_asset
any
default:USDC

Response

Quote created

id
string<uuid>
required
direction
enum<string>
required
Available options:
offramp,
onramp
status
enum<string>
required
Available options:
available,
consumed,
expired
source
object
required
destination
object
required
fees
object
required
exchange_rate
string
required
expires_at
string<date-time>
required
created_at
string<date-time>
required
beneficiary_id
string<uuid> | null
wallet_id
string<uuid> | null
estimated_delivery
string | null