🔁 Get Quote

Retrieve a quote for an on/off-ramp transaction. This provides the estimated fiat value a user would receive when converting a specified amount of crypto, including any applied spreads.

🔐 Headers

Header	Description
`partner-api-key`	API key associated with your partner account. Required. See API Key Generation Guide.

This endpoint requires authentication using a valid partner-api-key.

📥 Query Parameters

Parameter	Type	Required	Description
`tokenSymbol`	`string`	✅	Symbol of the crypto token (e.g., `USDC, USDT,MXNe`).
`transactionType`	`string`	✅	Type of transaction. Must be `"ON_RAMP"` or `"OFF_RAMP"`
`blockchainSymbol`	`string`	✅	Symbol of the blockchain where the token resides (e.g., `POL`,`BASE`,`SOL`, `BSC`).
`fiatCurrency`	`string`	✅	Fiat currency symbol (e.g., `MXN`, `DOP`).
`cryptoAmount`	`number`	🔘	Amount of crypto to be converted. Required if no fiatAmount input
`fiatAmount`	`number`	🔘	Amount of fiat to be converted. Required if no cryptoAmount input
`premiumSpread`	`number`	🔘	Optional spread applied to the exchange rate. If 0.01 it will increase the exchange rate by 1%

📨 Example Request

curl --request GET \
     --url 'https://staging-api.capa.fi/api/partner/v2/quotes?tokenSymbol=USDC&transactionType=ON_RAMP&blockchainSymbol=POL&fiatCurrency=MXN&cryptoAmount=100&premiumSpread=0.01' \
     --header 'accept: application/json' \
     --header 'partner-api-key: {{API-KEY}}'

📤 Response Body

Field	Type	Description
`success`	`boolean`	Indicates if the quote request was successful.
`transactionType`	`string`	Transaction type: `"ON_RAMP"` or `"OFF_RAMP"`.
`fiatAmount`	`number`	Estimated amount of fiat to be received or paid.
`fiatCurrency`	`string`	Fiat currency symbol (e.g., `MXN`, `DOP`).
`blockchainSymbol`	`string`	Blockchain used for the transaction (e.g., `POL`, `BASE`).
`tokenSymbol`	`string`	Crypto token symbol (e.g., `USDC`, `USDT`, `MXNe`).
`cryptoAmount`	`number`	Amount of crypto involved in the transaction.
`rate`	`number`	Exchange rate applied to the transaction.
`premiumSpread`	`number`	Spread percentage applied to the exchange rate (optional, if applied).
`flow`	`string`	Transaction flow type: “OTC”, “PAYMENT” OR “REGULAR”

📘 Example Response

{
  "success": true,
  "data": {
    "transactionType": "ON_RAMP",
    "fiatAmount": 1962.7009548859282,
    "fiatCurrency": "MXN",
    "blockchainSymbol": "POL",
    "tokenSymbol": "USDC",
    "cryptoAmount": 100,
    "rate": 19.63138734823794,
    "premiumSpread": 0.01,
    "flow": "OTC"
  }
}

⚠️ Important Notes & Requirements

Use Before Create Transaction: Always retrieve a quote before initiating an off-ramp transaction to provide accurate values.
Consistent Parameters: Ensure that the tokenSymbol, blockchainSymbol, and fiatCurrency match those used in the actual transaction.
Premium Spread: If premiumSpread is specified, it will reduce the rate to include the desired markup.

✅ Use Cases

Estimate Payout: Show users the estimated amount they’ll receive before confirming the off-ramp.
Dynamic Pricing: Adjust UI pricing and availability dynamically using the returned rate and spread.

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)

Example:

100

fiatAmount

number

The amount of fiat (required for ON_RAMP)

Example:

5000

premiumSpread

number

Spread percentage to be applied to the exchange rate

Example:

0.01

Response

200 - application/json

Successful response

success

boolean

Example:

true

data

object

Show child attributes

data.fiatAmount

number

required

Amount to be exchanged in fiat (DOP or MXN)

Example:

5000

data.fiatCurrency

enum<string>

required

This field refers to the currency that user will sent

Available options:

MXN,

DOP,

USD,

EUR

Example:

"DOP, MXN"

data.blockchainSymbol

enum<string>

required

This field represents the blockchain symbol

Available options:

POL,

SOL,

BASE,

ARB,

BSC,

OP,

WLD,

STK,

ETH,

MTN,

CORE

Example:

"ARB"

data.tokenSymbol

enum<string>

required

This field refers to the token symbol that user will received

Available options:

USDC,

USDT,

MXNe,

SOL,

ETH,

wBTC,

cbBTC,

PYSUD,

POL,

BNB,

WLD,

STK,

USDY,

CORE,

USDC.e,

wUSDL,

CoreBTC,

MATIC,

USDbC

Example:

"USDC"

data.transactionType

enum<string>

required

Transaction type

Available options:

ON_RAMP,

OFF_RAMP,

CROSS_RAMP

Example:

"ON_RAMP"

data.cryptoAmount

number

required

Amount the user would received in crypto

Example:

40

data.rate

number

required

Sell exchange rate used to buy usdc

Example:

57.01

data.flow

enum<string>

required

Transaction flow based on the amount

Available options:

OTC,

PAYMENT,

REGULAR

Example:

"REGULAR | OTC"

data.premiumSpread

number

Premium spread

Example:

0.01

Capa Partner API - V2

​🔁 Get Quote

​🔐 Headers

​📥 Query Parameters

​📨 Example Request

​📤 Response Body

​📘 Example Response

​⚠️ Important Notes & Requirements

​✅ Use Cases

Headers

Query Parameters

Response

🔁 Get Quote

🔐 Headers

📥 Query Parameters

📨 Example Request

📤 Response Body

📘 Example Response

⚠️ Important Notes & Requirements

✅ Use Cases