Get Quote Rate - Capa.fi

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/quotes \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/quotes"

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/quotes', 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://staging-api.capa.fi/api/partner/v2/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-api.capa.fi/api/partner/v2/quotes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://staging-api.capa.fi/api/partner/v2/quotes")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "fiatAmount": 5000,
    "fiatCurrency": "MXN",
    "blockchainSymbol": "POL",
    "tokenSymbol": "USDC",
    "transactionType": "ON_RAMP",
    "cryptoAmount": 40,
    "rate": 57.01,
    "premiumSpread": 0.01,
    "flow": "REGULAR"
  }
}

GET

api

partner

quotes

cURL

curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/quotes \
  --header 'partner-api-key: <api-key>'

import requests

url = "https://staging-api.capa.fi/api/partner/v2/quotes"

headers = {"partner-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'partner-api-key': '<api-key>'}};

fetch('https://staging-api.capa.fi/api/partner/v2/quotes', 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://staging-api.capa.fi/api/partner/v2/quotes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "partner-api-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"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-api.capa.fi/api/partner/v2/quotes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("partner-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://staging-api.capa.fi/api/partner/v2/quotes")
  .header("partner-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging-api.capa.fi/api/partner/v2/quotes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["partner-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "fiatAmount": 5000,
    "fiatCurrency": "MXN",
    "blockchainSymbol": "POL",
    "tokenSymbol": "USDC",
    "transactionType": "ON_RAMP",
    "cryptoAmount": 40,
    "rate": 57.01,
    "premiumSpread": 0.01,
    "flow": "REGULAR"
  }
}

Retrieves a real-time exchange rate quote for an on-ramp or off-ramp transaction. Use this to display estimated conversion amounts to users before they commit to a transaction.

Field Relationships

cryptoAmount is required for OFF_RAMP transactions, fiatAmount is required for ON_RAMP.
country and rail are optional overrides — use them only when the currency is not the default for the country (e.g., USD in China via SWIFT).

Important Notes

This returns a real-time rate that is not locked. To lock a rate, use POST /api/partner/v2/quotes instead.
The flow field indicates whether the transaction qualifies as OTC, PAYMENT, or REGULAR based on the amount.
Use consistent tokenSymbol, blockchainSymbol, and fiatCurrency values when creating the actual transaction.

Error Codes

Common Errors

HTTP Status	Code	Message
401	`UNAUTHORIZED`	”API Key is missing”
401	`UNAUTHORIZED`	”Invalid API Key format”
401	`UNAUTHORIZED`	”Invalid API Key”
403	`INVALID_PARTNER_FLOW`	”The partner has an invalid flow.”

Endpoint-Specific Errors

HTTP Status	Code	Message
400	`INVALID_USER_INPUT_ERROR`	”Invalid User Input”
400	`BAD_REQUEST`	”Fiat currency is disabled or does not exist”
400	`BAD_REQUEST`	”This blockchain and token combination is disabled or does not exist”
500	`INTERNAL_SERVER_ERROR`	”Internal error doing quote”

Authorizations

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Query Parameters

tokenSymbol

enum<string>

required

The token symbol

Available options:

USDC,

USDT

Example:

"USDC"

transactionType

enum<string>

required

Transaction type (ON_RAMP or OFF_RAMP)

Available options:

ON_RAMP,

OFF_RAMP,

CROSS_RAMP

Example:

"ON_RAMP"

blockchainSymbol

enum<string>

required

The blockchain symbol. BSC is only available for transactions over 50,000 MXN.

Available options:

POL,

SOL,

ETH,

BSC

Example:

"POL"

fiatCurrency

enum<string>

required

The fiat currency

Available options:

MXN,

DOP,

USD,

EUR

Example:

"MXN"

cryptoAmount

number

The amount of crypto (required for OFF_RAMP)

fiatAmount

number

The amount of fiat (required for ON_RAMP)

premiumSpread

number

Spread percentage to be applied to the exchange rate

country

enum<string>

The country where the transaction is being performed. Use it only when the currency is not default for the country.

Available options:

MX,

DO,

US,

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

IS,

LI,

NO,

CH,

GB,

MC,

SM,

AD,

VA,

CN

rail

enum<string>

The payment rail for the transaction. Use it only when the rail is not default for the country.

Available options:

SPEI,

ACH,

WIRE,

SEPA,

SWIFT

Response

Successful response

success

boolean

Example:

true

data

object

Show child attributes

Create Quote Create On-Ramp

⌘I

​Field Relationships

​Important Notes

​Error Codes

​Common Errors

​Endpoint-Specific Errors

Authorizations

Query Parameters

Response

Field Relationships

Important Notes

Error Codes

Common Errors

Endpoint-Specific Errors