cURL
Cross-Ramp
Get Cross-Ramp Rate
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.
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.
- To quote a USD payout to China (CN) or Hong Kong (HK), pass
targetCountry=CN(orHK) and optionallytargetRail(LOCALdefault, orSWIFT). See the Cross-Ramp guide.
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” |
Authorizations
API key for the affiliated partner 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
Target country. Required to quote a USD payout to China (CN) or Hong Kong (HK), since USD otherwise defaults to the US.
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, HK Target payment rail for CN/HK destinations. Defaults to LOCAL; use SWIFT for an international wire.
Available options:
LOCAL, SWIFT