cURL
Cross-Ramp
/api/partner/v2/cross-ramp/quotes
GET
cURL
Retrieves a real-time exchange rate for a fiat-to-fiat (cross-ramp) conversion. Use this to display estimated amounts before creating a transaction.Documentation Index
Fetch the complete documentation index at: https://docs.capa.fi/llms.txt
Use this file to discover all available pages before exploring further.
Field Relationships
- Provide either
sourceAmountortargetAmount, not both.
Important Notes
- This returns a real-time rate that is not locked. To lock a rate, use POST /api/partner/v2/cross-ramp/quotes.
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 | ”Requested fiat currency is invalid or inactive” |
Headers
Api key for the affiliated partner that is performing the request
Query Parameters
The source fiat currency symbol
Available options:
MXN, DOP, USD, EUR Example:
"MXN"
The target fiat currency symbol
Available options:
MXN, DOP, USD, EUR Example:
"USD"
The amount of source fiat currency to convert
The desired amount of target fiat currency to receive
Spread percentage to be applied to the exchange rate