Create an autoconversion rule

curl --request POST \
  --url https://api.lumx.io/autoconversion-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
  "targetCurrency": "USDC",
  "purpose": "INVESTMENT",
  "name": "BRL → USDC investment",
  "blockchain": "POLYGON",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
'

import requests

url = "https://api.lumx.io/autoconversion-rules"

payload = {
    "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
    "targetCurrency": "USDC",
    "purpose": "INVESTMENT",
    "name": "BRL → USDC investment",
    "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({
    accountId: '44dd9734-176a-4ced-924f-103f8d50ea5e',
    targetCurrency: 'USDC',
    purpose: 'INVESTMENT',
    name: 'BRL → USDC investment',
    blockchain: 'POLYGON',
    partnerFeeId: '123e4567-e89b-12d3-a456-426614174004'
  })
};

fetch('https://api.lumx.io/autoconversion-rules', 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/autoconversion-rules",
  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([
    'accountId' => '44dd9734-176a-4ced-924f-103f8d50ea5e',
    'targetCurrency' => 'USDC',
    'purpose' => 'INVESTMENT',
    'name' => 'BRL → USDC investment',
    '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/autoconversion-rules"

	payload := strings.NewReader("{\n  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\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/autoconversion-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/autoconversion-rules")

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  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}"

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

{
  "id": "c7f64332-5d53-4685-8aa9-48a5348c18c2",
  "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004",
  "status": "ACTIVE",
  "provider": "STARKBANK",
  "sourceCurrency": "BRL",
  "targetCurrency": "USDC",
  "blockchain": "POLYGON",
  "purpose": "INVESTMENT",
  "sourceDepositInfo": [
    {
      "rail": "PIX",
      "brCode": "00020126...5204",
      "depositIdentifier": "IIDCDYjYUTbKouEUOyvxZ3xnU"
    }
  ],
  "createdAt": "2026-07-08T23:18:58.574Z"
}

POST

autoconversion-rules

Create an autoconversion rule

curl --request POST \
  --url https://api.lumx.io/autoconversion-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
  "targetCurrency": "USDC",
  "purpose": "INVESTMENT",
  "name": "BRL → USDC investment",
  "blockchain": "POLYGON",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004"
}
'

import requests

url = "https://api.lumx.io/autoconversion-rules"

payload = {
    "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
    "targetCurrency": "USDC",
    "purpose": "INVESTMENT",
    "name": "BRL → USDC investment",
    "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({
    accountId: '44dd9734-176a-4ced-924f-103f8d50ea5e',
    targetCurrency: 'USDC',
    purpose: 'INVESTMENT',
    name: 'BRL → USDC investment',
    blockchain: 'POLYGON',
    partnerFeeId: '123e4567-e89b-12d3-a456-426614174004'
  })
};

fetch('https://api.lumx.io/autoconversion-rules', 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/autoconversion-rules",
  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([
    'accountId' => '44dd9734-176a-4ced-924f-103f8d50ea5e',
    'targetCurrency' => 'USDC',
    'purpose' => 'INVESTMENT',
    'name' => 'BRL → USDC investment',
    '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/autoconversion-rules"

	payload := strings.NewReader("{\n  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\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/autoconversion-rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lumx.io/autoconversion-rules")

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  \"accountId\": \"44dd9734-176a-4ced-924f-103f8d50ea5e\",\n  \"targetCurrency\": \"USDC\",\n  \"purpose\": \"INVESTMENT\",\n  \"name\": \"BRL → USDC investment\",\n  \"blockchain\": \"POLYGON\",\n  \"partnerFeeId\": \"123e4567-e89b-12d3-a456-426614174004\"\n}"

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

{
  "id": "c7f64332-5d53-4685-8aa9-48a5348c18c2",
  "accountId": "44dd9734-176a-4ced-924f-103f8d50ea5e",
  "partnerFeeId": "123e4567-e89b-12d3-a456-426614174004",
  "status": "ACTIVE",
  "provider": "STARKBANK",
  "sourceCurrency": "BRL",
  "targetCurrency": "USDC",
  "blockchain": "POLYGON",
  "purpose": "INVESTMENT",
  "sourceDepositInfo": [
    {
      "rail": "PIX",
      "brCode": "00020126...5204",
      "depositIdentifier": "IIDCDYjYUTbKouEUOyvxZ3xnU"
    }
  ],
  "createdAt": "2026-07-08T23:18:58.574Z"
}

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

accountId

string<uuid>

required

Account that receives the deposits. Must belong to your project.

Example:

"44dd9734-176a-4ced-924f-103f8d50ea5e"

targetCurrency

enum<string>

required

Asset to convert deposits into.

Available options:

USDC,

USDT

Example:

"USDC"

purpose

enum<string>

required

End-use category of the funds.

Available options:

PERSONAL_ACCOUNT,

INVESTMENT,

REAL_ESTATE,

TRADE_TRANSACTIONS,

TAX,

LOAN,

BILLS,

EXPENSES_REIMBURSEMENT,

PROFESSIONAL_SERVICES

Example:

"INVESTMENT"

name

string

required

A label for the rule, visible only to you.

Example:

"BRL → USDC investment"

blockchain

enum<string>

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

Available options:

ETHEREUM,

BASE,

TRON,

POLYGON

Example:

"POLYGON"

partnerFeeId

string<uuid>

Partner fee applied to each conversion. Must belong to your project.

Example:

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

Response

201 - application/json

Resource successfully created.

string<uuid>

Autoconversion rule's unique identifier.

Example:

"c7f64332-5d53-4685-8aa9-48a5348c18c2"

accountId

string<uuid>

Account that receives the deposits.

Example:

"44dd9734-176a-4ced-924f-103f8d50ea5e"

partnerFeeId

string<uuid> | null

Partner fee applied to each conversion. null when not set.

Example:

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

status

enum<string>

Autoconversion rule's status.

Available options:

ACTIVE

Example:

"ACTIVE"

provider

enum<string>

Banking provider that matches the deposits.

Available options:

STARKBANK,

FINTOC,

ONE_MONEY

Example:

"STARKBANK"

sourceCurrency

enum<string>

Source currency of the conversions, derived from the account's currency.

Available options:

USD,

BRL,

EUR,

MXN

Example:

"BRL"

targetCurrency

enum<string>

Asset deposits are converted into.

Available options:

USDC,

USDT

Example:

"USDC"

blockchain

enum<string>

Blockchain the converted asset is delivered on.

Available options:

ETHEREUM,

BASE,

TRON,

POLYGON

Example:

"POLYGON"

purpose

enum<string>

End-use category of the funds.

Available options:

PERSONAL_ACCOUNT,

INVESTMENT,

REAL_ESTATE,

TRADE_TRANSACTIONS,

TAX,

LOAN,

BILLS,

EXPENSES_REIMBURSEMENT,

PROFESSIONAL_SERVICES

Example:

"INVESTMENT"

sourceDepositInfo

object[]

Deposit details to share with the sender, per rail.

Show child attributes

createdAt

string<date-time>

Creation date and time (UTC).

Example:

"2026-07-08T23:18:58.574Z"

Read all autoconversion rules

Read an autoconversion rule