Actualizar un Portafolio

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "US Dollar Portfolio",
  "status": {
    "code": "INACTIVE",
    "description": "Portfolio temporarily deactivated due to compliance review"
  },
  "metadata": {
    "riskProfile": "medium",
    "portfolioManager": "wealth-management-team",
    "minBalanceRequirement": 600000,
    "automaticEnrollment": true,
    "eligibilityCriteria": "KYC level 4 and internal credit score > 820",
    "currencyExposure": "USD",
    "investmentProfile": "balanced"
  }
}
'

import requests

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

payload = {
    "name": "US Dollar Portfolio",
    "status": {
        "code": "INACTIVE",
        "description": "Portfolio temporarily deactivated due to compliance review"
    },
    "metadata": {
        "riskProfile": "medium",
        "portfolioManager": "wealth-management-team",
        "minBalanceRequirement": 600000,
        "automaticEnrollment": True,
        "eligibilityCriteria": "KYC level 4 and internal credit score > 820",
        "currencyExposure": "USD",
        "investmentProfile": "balanced"
    }
}
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: 'US Dollar Portfolio',
    status: {
      code: 'INACTIVE',
      description: 'Portfolio temporarily deactivated due to compliance review'
    },
    metadata: {
      riskProfile: 'medium',
      portfolioManager: 'wealth-management-team',
      minBalanceRequirement: 600000,
      automaticEnrollment: true,
      eligibilityCriteria: 'KYC level 4 and internal credit score > 820',
      currencyExposure: 'USD',
      investmentProfile: 'balanced'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_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}/portfolios/{portfolio_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' => 'US Dollar Portfolio',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Portfolio temporarily deactivated due to compliance review'
    ],
    'metadata' => [
        'riskProfile' => 'medium',
        'portfolioManager' => 'wealth-management-team',
        'minBalanceRequirement' => 600000,
        'automaticEnrollment' => true,
        'eligibilityCriteria' => 'KYC level 4 and internal credit score > 820',
        'currencyExposure' => 'USD',
        'investmentProfile' => 'balanced'
    ]
  ]),
  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}/portfolios/{portfolio_id}"

	payload := strings.NewReader("{\n  \"name\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\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}/portfolios/{portfolio_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_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\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\n  }\n}"

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",
  "entityId": "<string>",
  "name": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "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}

portfolios

{portfolio_id}

Actualizar un Portafolio

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "US Dollar Portfolio",
  "status": {
    "code": "INACTIVE",
    "description": "Portfolio temporarily deactivated due to compliance review"
  },
  "metadata": {
    "riskProfile": "medium",
    "portfolioManager": "wealth-management-team",
    "minBalanceRequirement": 600000,
    "automaticEnrollment": true,
    "eligibilityCriteria": "KYC level 4 and internal credit score > 820",
    "currencyExposure": "USD",
    "investmentProfile": "balanced"
  }
}
'

import requests

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

payload = {
    "name": "US Dollar Portfolio",
    "status": {
        "code": "INACTIVE",
        "description": "Portfolio temporarily deactivated due to compliance review"
    },
    "metadata": {
        "riskProfile": "medium",
        "portfolioManager": "wealth-management-team",
        "minBalanceRequirement": 600000,
        "automaticEnrollment": True,
        "eligibilityCriteria": "KYC level 4 and internal credit score > 820",
        "currencyExposure": "USD",
        "investmentProfile": "balanced"
    }
}
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: 'US Dollar Portfolio',
    status: {
      code: 'INACTIVE',
      description: 'Portfolio temporarily deactivated due to compliance review'
    },
    metadata: {
      riskProfile: 'medium',
      portfolioManager: 'wealth-management-team',
      minBalanceRequirement: 600000,
      automaticEnrollment: true,
      eligibilityCriteria: 'KYC level 4 and internal credit score > 820',
      currencyExposure: 'USD',
      investmentProfile: 'balanced'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_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}/portfolios/{portfolio_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' => 'US Dollar Portfolio',
    'status' => [
        'code' => 'INACTIVE',
        'description' => 'Portfolio temporarily deactivated due to compliance review'
    ],
    'metadata' => [
        'riskProfile' => 'medium',
        'portfolioManager' => 'wealth-management-team',
        'minBalanceRequirement' => 600000,
        'automaticEnrollment' => true,
        'eligibilityCriteria' => 'KYC level 4 and internal credit score > 820',
        'currencyExposure' => 'USD',
        'investmentProfile' => 'balanced'
    ]
  ]),
  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}/portfolios/{portfolio_id}"

	payload := strings.NewReader("{\n  \"name\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\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}/portfolios/{portfolio_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_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\": \"US Dollar Portfolio\",\n  \"status\": {\n    \"code\": \"INACTIVE\",\n    \"description\": \"Portfolio temporarily deactivated due to compliance review\"\n  },\n  \"metadata\": {\n    \"riskProfile\": \"medium\",\n    \"portfolioManager\": \"wealth-management-team\",\n    \"minBalanceRequirement\": 600000,\n    \"automaticEnrollment\": true,\n    \"eligibilityCriteria\": \"KYC level 4 and internal credit score > 820\",\n    \"currencyExposure\": \"USD\",\n    \"investmentProfile\": \"balanced\"\n  }\n}"

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",
  "entityId": "<string>",
  "name": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "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.

portfolio_id

string<uuid>

requerido

El identificador único del portafolio que desea recuperar, eliminar o actualizar.

Cuerpo

application/json

entityId

string

El identificador único del usuario responsable del portafolio.

Maximum string length: 256

name

string

El nombre del portafolio.

status

object

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

Show child attributes

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.

Show child attributes

Respuesta

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

string<uuid>

El identificador único del portafolio.

organizationId

string<uuid>

El identificador único de la Organización.

ledgerId

string<uuid>

El identificador único del Ledger.

entityId

string

El identificador único del usuario responsable del portafolio.

name

string

El nombre del Portafolio.

Maximum string length: 256

status

object

Un objeto que contiene información sobre el estado.

Show child attributes

metadata

object

Show child attributes

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

Recuperar un Portafolio

Eliminar un Portafolio

⌘I