Get an exchange rate

curl --request POST \
  --url https://api.lumx.io/exchange-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "FLOATING",
  "rail": "PIX",
  "sourceCurrency": "BRL",
  "sourceAmount": "60000.00",
  "targetCurrency": "USDC",
  "blockchain": "POLYGON",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
'

import requests

url = "https://api.lumx.io/exchange-rates"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "FLOATING",
    "rail": "PIX",
    "sourceCurrency": "BRL",
    "sourceAmount": "60000.00",
    "targetCurrency": "USDC",
    "blockchain": "POLYGON",
    "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
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({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'FLOATING',
    rail: 'PIX',
    sourceCurrency: 'BRL',
    sourceAmount: '60000.00',
    targetCurrency: 'USDC',
    blockchain: 'POLYGON',
    partnerFeeId: '123e4567-e89b-12d3-a456-426614174004'
  })
};

fetch('https://api.lumx.io/exchange-rates', 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.lumx.io/exchange-rates",
  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([
    'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'FLOATING',
    'rail' => 'PIX',
    'sourceCurrency' => 'BRL',
    'sourceAmount' => '60000.00',
    'targetCurrency' => 'USDC',
    'blockchain' => 'POLYGON',
    'partnerFeeId' => '123e4567-e89b-12d3-a456-426614174004'
  ]),
  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.lumx.io/exchange-rates"

	payload := strings.NewReader("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\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.lumx.io/exchange-rates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/exchange-rates")

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  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}"

response = http.request(request)
puts response.read_body

{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "FLOATING",
  "rail": "PIX",
  "sourceCurrency": "BRL",
  "sourceAmount": "59255.50",
  "targetCurrency": "USDC",
  "baseTargetAmount": "10000.000000",
  "baseExchangeRate": "5.9255",
  "fees": {
    "lumx": {
      "rate": "10",
      "flatAmount": "1",
      "totalAmount": "11",
      "currency": "USDC"
    },
    "partner": {
      "rate": "10",
      "flatAmount": "1",
      "totalAmount": "11",
      "currency": "USDC"
    }
  },
  "finalTargetAmount": "9978.000000",
  "finalExchangeRate": "5.9386"
}

POST

exchange-rates

Get an exchange rate

curl --request POST \
  --url https://api.lumx.io/exchange-rates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "FLOATING",
  "rail": "PIX",
  "sourceCurrency": "BRL",
  "sourceAmount": "60000.00",
  "targetCurrency": "USDC",
  "blockchain": "POLYGON",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
'

import requests

url = "https://api.lumx.io/exchange-rates"

payload = {
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "FLOATING",
    "rail": "PIX",
    "sourceCurrency": "BRL",
    "sourceAmount": "60000.00",
    "targetCurrency": "USDC",
    "blockchain": "POLYGON",
    "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
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({
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'FLOATING',
    rail: 'PIX',
    sourceCurrency: 'BRL',
    sourceAmount: '60000.00',
    targetCurrency: 'USDC',
    blockchain: 'POLYGON',
    partnerFeeId: '123e4567-e89b-12d3-a456-426614174004'
  })
};

fetch('https://api.lumx.io/exchange-rates', 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.lumx.io/exchange-rates",
  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([
    'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'FLOATING',
    'rail' => 'PIX',
    'sourceCurrency' => 'BRL',
    'sourceAmount' => '60000.00',
    'targetCurrency' => 'USDC',
    'blockchain' => 'POLYGON',
    'partnerFeeId' => '123e4567-e89b-12d3-a456-426614174004'
  ]),
  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.lumx.io/exchange-rates"

	payload := strings.NewReader("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\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.lumx.io/exchange-rates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/exchange-rates")

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  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"FLOATING\",\n  \"rail\": \"PIX\",\n  \"sourceCurrency\": \"BRL\",\n  \"sourceAmount\": \"60000.00\",\n  \"targetCurrency\": \"USDC\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}"

response = http.request(request)
puts response.read_body

{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "FLOATING",
  "rail": "PIX",
  "sourceCurrency": "BRL",
  "sourceAmount": "59255.50",
  "targetCurrency": "USDC",
  "baseTargetAmount": "10000.000000",
  "baseExchangeRate": "5.9255",
  "fees": {
    "lumx": {
      "rate": "10",
      "flatAmount": "1",
      "totalAmount": "11",
      "currency": "USDC"
    },
    "partner": {
      "rate": "10",
      "flatAmount": "1",
      "totalAmount": "11",
      "currency": "USDC"
    }
  },
  "finalTargetAmount": "9978.000000",
  "finalExchangeRate": "5.9386"
}

Authorizations

Authorization

string

header

required

Bearer authentication header on the format Bearer <API_KEY>.

Headers

Idempotency-Key

string<uuid>

Optional UUID v4 idempotency key. If you resend the same key with a different request body, the API returns a 409 error. Cached responses include the header X-Idempotency-Cached: true. Keys expire after 24 hours.

Body

application/json

Floating
Locked

Exchange rate's type is floating.

customerId

string<uuid>

required

Customer's unique identifier.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

type

enum<string>

required

Exchange rate type.

Available options:

FLOATING

Example:

"FLOATING"

rail

enum<string>

required

Exchange rate payment rail.

Available options:

PIX,

SWIFT,

SEPA,

ACH,

FEDWIRE,

SPEI

Example:

"PIX"

sourceCurrency

enum<string>

required

Exchange rate source currency.

Available options:

BRL,

USD,

EUR,

MXN,

USDC,

USDT

Example:

"BRL"

sourceAmount

string

required

Exchange rate source amount.

Example:

"60000.00"

targetCurrency

enum<string>

required

Exchange rate target currency.

Available options:

BRL,

USD,

EUR,

MXN,

USDC,

USDT

Example:

"USDC"

blockchain

enum<string>

Target blockchain for the exchange rate calculation. If not provided, the project's default blockchain will be used.

Available options:

ETHEREUM,

BASE,

TRON,

POLYGON

Example:

"POLYGON"

partnerFeeId

string<uuid>

Exchange rate partner fee ID.

Example:

"123e4567-e89b-12d3-a456-426614174004"

Response

200 - application/json

Resource successfully retrieved.

Floating
Locked

Exchange rate's type is floating.

type

enum<string>

Exchange rate type.

Available options:

FLOATING

Example:

"FLOATING"

rail

enum<string>

Exchange rate payment rail.

Available options:

PIX,

SWIFT,

SEPA,

ACH,

FEDWIRE,

SPEI

Example:

"PIX"

sourceCurrency

string

Exchange rate source currency.

Example:

"BRL"

sourceAmount

string

Exchange rate source amount.

Example:

"60000.00"

targetCurrency

string

Exchange rate target currency.

Example:

"USDC"

targetAmount

string

Exchange rate target amount.

Example:

"10125.727780"

rate

string

The exchange rate between the currencies.

Example:

"5.9255"

Read a destination

Read all transactions

Customers

Accounts

Destinations

Exchange Rates

Transactions

Partner Fees

Autoconversion Rules

Get an exchange rate

Authorizations

Headers

Body

Response