Skip to main content
GET
/
api
/
partner
/
v2
/
quotes
cURL
curl --request GET \
  --url https://staging-api.capa.fi/api/partner/v2/quotes \
  --header 'partner-api-key: <partner-api-key>'
{
  "success": true,
  "data": {
    "fiatAmount": 5000,
    "fiatCurrency": "DOP, MXN",
    "blockchainSymbol": "ARB",
    "tokenSymbol": "USDC",
    "transactionType": "ON_RAMP",
    "cryptoAmount": 40,
    "rate": 57.01,
    "flow": "REGULAR | OTC",
    "premiumSpread": 0.01
  }
}
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 StatusCodeMessage
401UNAUTHORIZED”API Key is missing”
401UNAUTHORIZED”Invalid API Key format”
401UNAUTHORIZED”Invalid API Key”
403INVALID_PARTNER_FLOW”The partner has an invalid flow.”

​
Endpoint-Specific Errors

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

Headers

​
partner-api-key
string
required

Api key for the affiliated partner that is performing the request

Query Parameters

​
tokenSymbol
enum<string>
required

The token symbol

Available options:
USDC,
USDT,
MXNe,
SOL,
ETH,
wBTC,
cbBTC,
PYSUD,
POL,
BNB,
WLD,
STK,
USDY,
CORE,
USDC.e,
wUSDL,
CoreBTC,
MATIC,
USDbC
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

Available options:
POL,
SOL,
BASE,
ARB,
BSC,
OP,
WLD,
STK,
ETH,
MTN,
CORE
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

200 - application/json

Successful response

​
success
boolean
Example:

true

​
data
object