Create a CARF rule
curl --request POST \
--url https://api.range.org/v2/workflows/{workflowId}/carf/rules \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Supplier payments",
"conditions": {
"from_wallets": [
"<string>"
],
"to_wallets": [
"<string>"
],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": [
"<string>"
],
"networks": [
"eth",
"solana"
]
},
"enabled": true
}
'import requests
url = "https://api.range.org/v2/workflows/{workflowId}/carf/rules"
payload = {
"name": "Supplier payments",
"conditions": {
"from_wallets": ["<string>"],
"to_wallets": ["<string>"],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": ["<string>"],
"networks": ["eth", "solana"]
},
"enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Supplier payments',
conditions: {
from_wallets: ['<string>'],
to_wallets: ['<string>'],
usd_min: 1,
usd_max: 1,
token_min: 1,
token_max: 1,
assets: ['<string>'],
networks: ['eth', 'solana']
},
enabled: true
})
};
fetch('https://api.range.org/v2/workflows/{workflowId}/carf/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.range.org/v2/workflows/{workflowId}/carf/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([
'name' => 'Supplier payments',
'conditions' => [
'from_wallets' => [
'<string>'
],
'to_wallets' => [
'<string>'
],
'usd_min' => 1,
'usd_max' => 1,
'token_min' => 1,
'token_max' => 1,
'assets' => [
'<string>'
],
'networks' => [
'eth',
'solana'
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.range.org/v2/workflows/{workflowId}/carf/rules"
payload := strings.NewReader("{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.range.org/v2/workflows/{workflowId}/carf/rules")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/workflows/{workflowId}/carf/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "CARF501",
"conditions": {
"direction": "in",
"from_wallets": [
"<string>"
],
"to_wallets": [
"<string>"
],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": [
"<string>"
],
"networks": [
"eth",
"solana"
]
},
"enabled": true,
"position": 123,
"created_at": "<string>",
"updated_at": "<string>"
}CARF
Create a CARF rule
A rule sets a CARF code on matching transfers. It beats every automatic decision and loses only to a manual label; when several rules match, the narrowest wins (a wallet, then an asset, then the narrower amount range, then a network), then the lower position. Changes reclassify unsent transfers in the background; a deleted rule keeps the codes it already set.
POST
/
v2
/
workflows
/
{workflowId}
/
carf
/
rules
Create a CARF rule
curl --request POST \
--url https://api.range.org/v2/workflows/{workflowId}/carf/rules \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "Supplier payments",
"conditions": {
"from_wallets": [
"<string>"
],
"to_wallets": [
"<string>"
],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": [
"<string>"
],
"networks": [
"eth",
"solana"
]
},
"enabled": true
}
'import requests
url = "https://api.range.org/v2/workflows/{workflowId}/carf/rules"
payload = {
"name": "Supplier payments",
"conditions": {
"from_wallets": ["<string>"],
"to_wallets": ["<string>"],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": ["<string>"],
"networks": ["eth", "solana"]
},
"enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Supplier payments',
conditions: {
from_wallets: ['<string>'],
to_wallets: ['<string>'],
usd_min: 1,
usd_max: 1,
token_min: 1,
token_max: 1,
assets: ['<string>'],
networks: ['eth', 'solana']
},
enabled: true
})
};
fetch('https://api.range.org/v2/workflows/{workflowId}/carf/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.range.org/v2/workflows/{workflowId}/carf/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([
'name' => 'Supplier payments',
'conditions' => [
'from_wallets' => [
'<string>'
],
'to_wallets' => [
'<string>'
],
'usd_min' => 1,
'usd_max' => 1,
'token_min' => 1,
'token_max' => 1,
'assets' => [
'<string>'
],
'networks' => [
'eth',
'solana'
]
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.range.org/v2/workflows/{workflowId}/carf/rules"
payload := strings.NewReader("{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.range.org/v2/workflows/{workflowId}/carf/rules")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/workflows/{workflowId}/carf/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Supplier payments\",\n \"conditions\": {\n \"from_wallets\": [\n \"<string>\"\n ],\n \"to_wallets\": [\n \"<string>\"\n ],\n \"usd_min\": 1,\n \"usd_max\": 1,\n \"token_min\": 1,\n \"token_max\": 1,\n \"assets\": [\n \"<string>\"\n ],\n \"networks\": [\n \"eth\",\n \"solana\"\n ]\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "CARF501",
"conditions": {
"direction": "in",
"from_wallets": [
"<string>"
],
"to_wallets": [
"<string>"
],
"usd_min": 1,
"usd_max": 1,
"token_min": 1,
"token_max": 1,
"assets": [
"<string>"
],
"networks": [
"eth",
"solana"
]
},
"enabled": true,
"position": 123,
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
AuthorizationAuthorization
Authorization method required to allow user to access the api endpoints.
Path Parameters
Body
application/json
Maximum string length:
200Example:
"Supplier payments"
CARF5xx for in rules, CARF6xx for out rules.
Available options:
CARF501, CARF502, CARF503, CARF504, CARF505, CARF506, CARF507, CARF508, CARF509, CARF601, CARF602, CARF603, CARF604, CARF605, CARF606 Show child attributes
Show child attributes
Response
201 - application/json
Available options:
CARF501, CARF502, CARF503, CARF504, CARF505, CARF506, CARF507, CARF508, CARF509, CARF601, CARF602, CARF603, CARF604, CARF605, CARF606 Show child attributes
Show child attributes
Tie-break order; lower first.
Was this page helpful?