GET
/
api
/
partner
/
v1
/
quote
/
on-ramp
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v1/quote/on-ramp \
  --header 'partner-api-key: <partner-api-key>'
{
  "status": "ok",
  "data": {
    "fromAmount": 5000,
    "fromCurrency": "7a060937-adb5-45bb-bdd9-0fa7e80e2826",
    "toCurrency": "b878479a-61ce-46b2-b1f6-0e972327e6df",
    "toAmount": 40,
    "rate": 57.01
  }
}

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

​
fromAmount
number

The amount of fiat money to be exchanged.

Example:

1000

​
toAmount
number

The amount of crypto currency to be exchanged.

Example:

0.0001

​
fromCurrency
string
required

Even though the name indicates this is the currency that user will sent

  • this field refers to fiat currency id for on-ramp
  • this field refers to blockchain-to-token id for off-ramp
Example:

"7a060937-adb5-45bb-bdd9-0fa7e80e2826"

​
toCurrency
string
required

Even though the name indicates this is the currency that user will received

  • this field refers to blockchain-to-token id for on-ramp
  • this field refers to fiat currency id for off-ramp
Example:

"b878479a-61ce-46b2-b1f6-0e972327e6df"

​
premiumSpread
number

Spread percentage to be applied to the exchange rate

Example:

0.01

Response

200 - application/json
​
status
string
Example:

"ok"

​
data
object