Get a fee rule

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}', 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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "feeScheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "BB Right-Side Rule",
  "side": "RIGHT",
  "priority": 0,
  "predicates": [
    {
      "field": "institution",
      "operator": "EQUALS",
      "value": "Banco do Brasil",
      "values": [
        "<string>"
      ]
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

GET

fee-rules

{feeRuleId}

Get a fee rule

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}', 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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "feeScheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "BB Right-Side Rule",
  "side": "RIGHT",
  "priority": 0,
  "predicates": [
    {
      "field": "institution",
      "operator": "EQUALS",
      "value": "Banco do Brasil",
      "values": [
        "<string>"
      ]
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

{
  "code": "MTCH-0001",
  "title": "Bad Request",
  "message": "context not found",
  "error": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id

string

A unique identifier for tracing the request across services.

Path Parameters

feeRuleId

string<uuid>

required

The unique identifier of the fee rule.

Response

Successfully retrieved fee rule

A fee rule that maps transaction metadata to a fee schedule within a reconciliation context

string<uuid>

Unique identifier for the fee rule

Example:

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

contextId

string<uuid>

Reconciliation context this rule belongs to

Example:

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

feeScheduleId

string<uuid>

Fee schedule applied when this rule matches

Example:

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

name

string

Display name for the fee rule

Example:

"BB Right-Side Rule"

side

enum<string>

Which transaction side this rule applies to

Available options:

LEFT,

RIGHT,

ANY

Example:

"RIGHT"

priority

integer

Evaluation priority (lower numbers are evaluated first; LEFT, RIGHT, and ANY rules share the same priority space)

Example:

0

predicates

object[]

Conditions that must all match for this rule to apply

Show child attributes

createdAt

string<date-time>

Creation timestamp in RFC 3339 format

Example:

"2025-01-15T10:30:00Z"

updatedAt

string<date-time>

Last update timestamp in RFC 3339 format

Example:

"2025-01-15T10:30:00Z"

⌘I

Getting started

Configuration Contexts API

Configuration Match Rules API

Configuration Sources API

Configuration Field Maps API

Configuration Fee Schedules API

Configuration Fee Rules API

Configuration Schedules API

Exception workflow

Bulk actions

Comments

Callback credentials

Disputes API

Export Jobs API

Governance API

Ingestion jobs

Layouts and formats

Extraction reviews

Document extraction

Match runs

Manual matching and adjustments

Candidates and open items

Rule suggestions

Dashboard and metrics

Reports

Exports

Discovery status

Discovery connections

Extractions

Aggregator connections

Aggregator webhooks

Error handling

Get a fee rule

Authorizations

Headers

Path Parameters

Response