Saltar al contenido principal
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
Actualizar un 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"
}

Encabezados

​
Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

​
X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

​
Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

​
organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

​
ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

Cuerpo

application/json
​
name
string

El nombre del Ledger.

Maximum string length: 256
​
status
object

Un objeto que contiene información sobre el estado. Importante: Si no se proporciona, el estado predeterminado será 'ACTIVE'.

​
metadata
object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

​
id
string<uuid>

El identificador único del Ledger.

​
organizationId
string<uuid>

El identificador único de la Organización.

​
name
string

El nombre del Ledger.

Maximum string length: 256
​
status
object

Un objeto que contiene información sobre el estado.

​
metadata
object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.

​
settings
object

Las configuraciones actuales de un Ledger.

​
createdAt
string<date-time>

Fecha y hora de creación (UTC).

​
updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).