Retrieve a Transaction Route

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}', 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}/transaction-routes/{transaction_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

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

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transaction-routes

{transaction_route_id}

Retrieve a Transaction Route

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}', 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}/transaction-routes/{transaction_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}"

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

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "overdraft": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

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.

transaction_route_id

string<uuid>

required

The unique identifier of the Transaction Route that you want to retrieve.

Response

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

string<uuid>

The unique identifier of the Transaction 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 transaction. Used as an entry note for identification.

description

string

A description for the Transaction Route.

operationRoutes

object[]

List of objects containing information about the Operation Routes from the Transaction Route.

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'.

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

List Transaction Routes

Update a Transaction Route

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

Retrieve a Transaction Route

Path Parameters

Response