List Transaction Routes

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

import requests

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

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', 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",
  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"

	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")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "items": [
    {
      "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": {}
    }
  ],
  "next_cursor": "<string>",
  "prev_cursor": "<string>",
  "limit": 123
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transaction-routes

List Transaction Routes

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

import requests

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

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', 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",
  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"

	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")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "items": [
    {
      "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": {}
    }
  ],
  "next_cursor": "<string>",
  "prev_cursor": "<string>",
  "limit": 123
}

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.

Query Parameters

limit

integer

default:10

The maximum number of items to include in the response.

Required range: 1 <= x <= 100

start_date

string

The beginning of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

end_date

string

The end of the period you want to retrieve. start_date and end_date are all-or-nothing: supplying only one returns 400. If both are omitted, a default window of the last 1 month is used.

sort_order

enum<string>

default:asc

The order used to sort the results.

Available options:

asc,

desc

cursor

string

An encoded cursor token from a previous response (next_cursor or prev_cursor) to navigate forward or backward through results.

metadata.key

string

Filter by metadata using dot-notation. Replace key with your metadata field name (e.g. metadata.costCenter=BR_11101997).

Response

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

items

object[]

Show child attributes

next_cursor

string

Encoded cursor pointing to the next page of results.

prev_cursor

string

Encoded cursor pointing to the previous page of results.

limit

integer

The maximum number of items included in the response.

Create a Transaction Route

Retrieve 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

List Transaction Routes

Path Parameters

Query Parameters

Response