Get Cross-Ramp Rate

cURL

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

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

fetch('https://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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": {
    "fees": {
      "fixedFee": 25,
      "feeCurrency": "MXN"
    },
    "sourceAmount": 5000,
    "sourceCurrency": "MXN",
    "targetAmount": 40,
    "targetCurrency": "DOP",
    "rate": 57.01,
    "premiumSpread": 0.01,
    "spread": 0.005,
    "flow": "REGULAR"
  }
}

GET

api

partner

cross-ramp

quotes

cURL

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

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

fetch('https://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.capa.fi/api/partner/v2/cross-ramp/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": {
    "fees": {
      "fixedFee": 25,
      "feeCurrency": "MXN"
    },
    "sourceAmount": 5000,
    "sourceCurrency": "MXN",
    "targetAmount": 40,
    "targetCurrency": "DOP",
    "rate": 57.01,
    "premiumSpread": 0.01,
    "spread": 0.005,
    "flow": "REGULAR"
  }
}

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 sourceAmount or targetAmount, 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 (or HK) and optionally targetRail (LOCAL default, or SWIFT). 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

partner-api-key

string

header

required

API key for the affiliated partner performing the request.

Query Parameters

sourceCurrency

enum<string>

required

The source fiat currency symbol

Available options:

MXN,

DOP,

USD,

EUR

Example:

"MXN"

targetCurrency

enum<string>

required

The target fiat currency symbol

Available options:

MXN,

DOP,

USD,

EUR

Example:

"USD"

sourceAmount

number

The amount of source fiat currency to convert

targetAmount

number

The desired amount of target fiat currency to receive

premiumSpread

number

Spread percentage to be applied to the exchange rate

targetCountry

enum<string>

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

targetRail

enum<string>

Target payment rail for CN/HK destinations. Defaults to LOCAL; use SWIFT for an international wire.

Available options:

LOCAL,

SWIFT

Response

Successful response

success

boolean

Example:

true

data

object

Show child attributes

⌘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