Update a Ledger

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Ledger - Updated",
  "status": {
    "code": "INACTIVE",
    "description": "Ledger access temporarily suspended pending review."
  },
  "metadata": {
    "environment": "production",
    "region": "us-east-1",
    "businessDomain": "retail_banking",
    "supportedInstruments": "deposit_accounts,pix_transfers,internal_transfers",
    "multiCurrency": false,
    "updatedBy": "system_admin",
    "notes": "Ledger temporarily blocked due to compliance review"
  }
}
'

import requests

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

payload = {
    "name": "Primary Ledger - Updated",
    "status": {
        "code": "INACTIVE",
        "description": "Ledger access temporarily suspended pending review."
    },
    "metadata": {
        "environment": "production",
        "region": "us-east-1",
        "businessDomain": "retail_banking",
        "supportedInstruments": "deposit_accounts,pix_transfers,internal_transfers",
        "multiCurrency": False,
        "updatedBy": "system_admin",
        "notes": "Ledger temporarily blocked due to compliance review"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Primary Ledger - Updated',
    status: {
      code: 'INACTIVE',
      description: 'Ledger access temporarily suspended pending review.'
    },
    metadata: {
      environment: 'production',
      region: 'us-east-1',
      businessDomain: 'retail_banking',
      supportedInstruments: 'deposit_accounts,pix_transfers,internal_transfers',
      multiCurrency: false,
      updatedBy: 'system_admin',
      notes: 'Ledger temporarily blocked due to compliance review'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Primary Ledger - Updated',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Ledger access temporarily suspended pending review.'
    ],
    'metadata' => [
        'environment' => 'production',
        'region' => 'us-east-1',
        'businessDomain' => 'retail_banking',
        'supportedInstruments' => 'deposit_accounts,pix_transfers,internal_transfers',
        'multiCurrency' => false,
        'updatedBy' => 'system_admin',
        'notes' => 'Ledger temporarily blocked due to compliance review'
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "settings": {
    "accounting": {
      "validateAccountType": true,
      "validateRoutes": true
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

Update a Ledger

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Ledger - Updated",
  "status": {
    "code": "INACTIVE",
    "description": "Ledger access temporarily suspended pending review."
  },
  "metadata": {
    "environment": "production",
    "region": "us-east-1",
    "businessDomain": "retail_banking",
    "supportedInstruments": "deposit_accounts,pix_transfers,internal_transfers",
    "multiCurrency": false,
    "updatedBy": "system_admin",
    "notes": "Ledger temporarily blocked due to compliance review"
  }
}
'

import requests

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

payload = {
    "name": "Primary Ledger - Updated",
    "status": {
        "code": "INACTIVE",
        "description": "Ledger access temporarily suspended pending review."
    },
    "metadata": {
        "environment": "production",
        "region": "us-east-1",
        "businessDomain": "retail_banking",
        "supportedInstruments": "deposit_accounts,pix_transfers,internal_transfers",
        "multiCurrency": False,
        "updatedBy": "system_admin",
        "notes": "Ledger temporarily blocked due to compliance review"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Primary Ledger - Updated',
    status: {
      code: 'INACTIVE',
      description: 'Ledger access temporarily suspended pending review.'
    },
    metadata: {
      environment: 'production',
      region: 'us-east-1',
      businessDomain: 'retail_banking',
      supportedInstruments: 'deposit_accounts,pix_transfers,internal_transfers',
      multiCurrency: false,
      updatedBy: 'system_admin',
      notes: 'Ledger temporarily blocked due to compliance review'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Primary Ledger - Updated',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Ledger access temporarily suspended pending review.'
    ],
    'metadata' => [
        'environment' => 'production',
        'region' => 'us-east-1',
        'businessDomain' => 'retail_banking',
        'supportedInstruments' => 'deposit_accounts,pix_transfers,internal_transfers',
        'multiCurrency' => false,
        'updatedBy' => 'system_admin',
        'notes' => 'Ledger temporarily blocked due to compliance review'
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Primary Ledger - Updated\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Ledger access temporarily suspended pending review.\"\n  },\n  \"metadata\": {\n    \"environment\": \"production\",\n    \"region\": \"us-east-1\",\n    \"businessDomain\": \"retail_banking\",\n    \"supportedInstruments\": \"deposit_accounts,pix_transfers,internal_transfers\",\n    \"multiCurrency\": false,\n    \"updatedBy\": \"system_admin\",\n    \"notes\": \"Ledger temporarily blocked due to compliance review\"\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "settings": {
    "accounting": {
      "validateAccountType": true,
      "validateRoutes": true
    }
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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

name

string

The name of the Ledger.

Maximum string length: 256

status

object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

Show child attributes

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

Response

Indicates that the request was successful and the response contains the expected data.

string<uuid>

The unique identifier of the Ledger.

organizationId

string<uuid>

The unique identifier of the Organization.

name

string

The name of the Ledger.

Maximum string length: 256

status

object

An object containing information about the status.

Show child attributes

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

settings

object

The current settings of a Ledger.

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

Retrieve a Ledger

Delete a Ledger

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

Update a Ledger

Headers

Path Parameters

Body

Response