Skip to main content
POST
/
v1
/
conversions
Execute a conversion (consume a quote, terminal state inline)
curl --request POST \
  --url https://api.example.com/v1/conversions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quoteId": "550e8400-e29b-41d4-a716-446655440000"
}
'
import requests

url = "https://api.example.com/v1/conversions"

payload = { "quoteId": "550e8400-e29b-41d4-a716-446655440000" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({quoteId: '550e8400-e29b-41d4-a716-446655440000'})
};

fetch('https://api.example.com/v1/conversions', 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.example.com/v1/conversions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'quoteId' => '550e8400-e29b-41d4-a716-446655440000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/conversions"

	payload := strings.NewReader("{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/conversions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/conversions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"quoteId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"

response = http.request(request)
puts response.read_body
{
  "createdAt": "<string>",
  "fee": "0.0000",
  "feeCurrency": "USD",
  "id": "uuid",
  "rate": "1.09860000",
  "sourceAmount": "500.0000",
  "sourceCurrency": "USD",
  "status": "completed",
  "targetAmount": "455.1200",
  "targetCurrency": "EUR"
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Headers

​
Idempotency-Key
string

A repeat returns the original conversion result.

Body

application/json
​
quoteId
string
required

Id of the firm convert quote to execute

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

The executed conversion in its terminal state.

​
createdAt
string
required

Created at (ISO 8601)

​
fee
string
required

Fixed fee charged, in feeCurrency. Always 0 for conversions created after fixed fees were retired from converts.

Example:

"0.0000"

​
feeCurrency
string
required

Fee currency

Example:

"USD"

​
id
string
required

Conversion id

Example:

"uuid"

​
rate
string
required

All-in rate applied: source units per 1 target unit

Example:

"1.09860000"

​
sourceAmount
string
required

Debited from the source balance

Example:

"500.0000"

​
sourceCurrency
string
required

Source currency

Example:

"USD"

​
status
enum<string>
required

Terminal status

Available options:
completed,
failed
Example:

"completed"

​
targetAmount
string
required

Credited to the target balance

Example:

"455.1200"

​
targetCurrency
string
required

Target currency

Example:

"EUR"