Create an Operation Route

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "ruleType": "alias",
    "validIf": "@external/BRL"
  },
  "code": "PIX-DEBIT",
  "title": "Pix External Account Debit",
  "description": "Pix External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "operationType": "source",
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes"

payload = {
    "account": {
        "ruleType": "alias",
        "validIf": "@external/BRL"
    },
    "code": "PIX-DEBIT",
    "title": "Pix External Account Debit",
    "description": "Pix External Account Debit",
    "metadata": {
        "customField1": "value1",
        "customField2": 123
    },
    "operationType": "source",
    "accountingEntries": { "direct": {
            "debit": {
                "code": "1.1.001",
                "description": "Cash - Available funds"
            },
            "credit": {
                "code": "3.1.001",
                "description": "Service Revenue"
            }
        } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account: {ruleType: 'alias', validIf: '@external/BRL'},
    code: 'PIX-DEBIT',
    title: 'Pix External Account Debit',
    description: 'Pix External Account Debit',
    metadata: {customField1: 'value1', customField2: 123},
    operationType: 'source',
    accountingEntries: {
      direct: {
        debit: {code: '1.1.001', description: 'Cash - Available funds'},
        credit: {code: '3.1.001', description: 'Service Revenue'}
      }
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes', 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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes",
  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([
    'account' => [
        'ruleType' => 'alias',
        'validIf' => '@external/BRL'
    ],
    'code' => 'PIX-DEBIT',
    'title' => 'Pix External Account Debit',
    'description' => 'Pix External Account Debit',
    'metadata' => [
        'customField1' => 'value1',
        'customField2' => 123
    ],
    'operationType' => 'source',
    'accountingEntries' => [
        'direct' => [
                'debit' => [
                                'code' => '1.1.001',
                                'description' => 'Cash - Available funds'
                ],
                'credit' => [
                                'code' => '3.1.001',
                                'description' => 'Service Revenue'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes"

	payload := strings.NewReader("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")

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

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}"

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

{
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@external/BRL"
    ]
  },
  "code": "PIX-DEBIT",
  "description": "Pix External Account Debit",
  "operationType": "source",
  "action": "direct",
  "title": "Pix External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  },
  "createdAt": "2026-02-25T21:06:38.321656Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.321656Z"
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

operation-routes

Create an Operation Route

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "ruleType": "alias",
    "validIf": "@external/BRL"
  },
  "code": "PIX-DEBIT",
  "title": "Pix External Account Debit",
  "description": "Pix External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "operationType": "source",
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes"

payload = {
    "account": {
        "ruleType": "alias",
        "validIf": "@external/BRL"
    },
    "code": "PIX-DEBIT",
    "title": "Pix External Account Debit",
    "description": "Pix External Account Debit",
    "metadata": {
        "customField1": "value1",
        "customField2": 123
    },
    "operationType": "source",
    "accountingEntries": { "direct": {
            "debit": {
                "code": "1.1.001",
                "description": "Cash - Available funds"
            },
            "credit": {
                "code": "3.1.001",
                "description": "Service Revenue"
            }
        } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account: {ruleType: 'alias', validIf: '@external/BRL'},
    code: 'PIX-DEBIT',
    title: 'Pix External Account Debit',
    description: 'Pix External Account Debit',
    metadata: {customField1: 'value1', customField2: 123},
    operationType: 'source',
    accountingEntries: {
      direct: {
        debit: {code: '1.1.001', description: 'Cash - Available funds'},
        credit: {code: '3.1.001', description: 'Service Revenue'}
      }
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes', 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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes",
  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([
    'account' => [
        'ruleType' => 'alias',
        'validIf' => '@external/BRL'
    ],
    'code' => 'PIX-DEBIT',
    'title' => 'Pix External Account Debit',
    'description' => 'Pix External Account Debit',
    'metadata' => [
        'customField1' => 'value1',
        'customField2' => 123
    ],
    'operationType' => 'source',
    'accountingEntries' => [
        'direct' => [
                'debit' => [
                                'code' => '1.1.001',
                                'description' => 'Cash - Available funds'
                ],
                'credit' => [
                                'code' => '3.1.001',
                                'description' => 'Service Revenue'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes"

	payload := strings.NewReader("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")

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

	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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"Pix External Account Debit\",\n  \"description\": \"Pix External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}"

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

{
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@external/BRL"
    ]
  },
  "code": "PIX-DEBIT",
  "description": "Pix External Account Debit",
  "operationType": "source",
  "action": "direct",
  "title": "Pix External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  },
  "createdAt": "2026-02-25T21:06:38.321656Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.321656Z"
}

Headers

Content-Type

string

The type of media of the resource. Recommended value is application/json.

X-Request-Id

string<uuid>

A unique identifier used to trace and track each request.

Authorization

string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id

string<uuid>

required

The unique identifier of the Organization associated with the Ledger.

ledger_id

string<uuid>

required

The unique identifier of the associated Ledger.

Body

application/json

title

string

required

Short text summarizing the purpose of the operation. Used as an entry note for identification.

Maximum string length: 255

operationType

enum<string>

required

The type of the Operation Route. Use bidirectional when the route can operate in both directions.

Available options:

source,

destination,

bidirectional

account

object

Defines the rule for selecting the account that will participate in the operation (source or destination).

Show child attributes

code

string

deprecated

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

Maximum string length: 100

description

string

Detailed description of the Operation Route purpose and usage.

Maximum string length: 250

metadata

object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

Show child attributes

accountingEntries

object

Accounting entries grouped by transaction action type. Each action maps to a pair of debit and credit rubrics.

Show child attributes

Response

Indicates that the resource was successfully created and the operation was completed as expected.

string<uuid>

The unique identifier of the Operation Route.

organizationId

string<uuid>

The unique identifier of the Organization.

ledgerId

string<uuid>

The unique identifier of the Ledger.

title

string

Short text summarizing the purpose of the operation. Used as an entry note for identification.

code

string

deprecated

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

Maximum string length: 100

description

string

Detailed description of the Operation Route purpose and usage.

operationType

enum<string>

The type of the Operation Route. Use bidirectional when the route can operate in both directions.

Available options:

source,

destination,

bidirectional

accountingEntries

object

Accounting entries grouped by transaction action type. Each action maps to a pair of debit and credit rubrics.

Show child attributes

account

object

Defines the rule for selecting the account that will participate in the operation (debit or credit).

Show child attributes

createdAt

string<date-time>

Timestamp of creation (UTC).

updatedAt

string<date-time>

Timestamp of last update (UTC).

deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

metadata

object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes

Update an Operation

List Operation Routes

Getting started

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Metadata Indexes API

Holders API

Instruments API

Billing Packages API

Packages API

Billing Calculation API

Estimation API

Encryption API

Protection API

Asset Rates API

Error handling

Fees Engine

Create an Operation Route

Headers

Path Parameters

Body

Response