Crear un Activo

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Brazilian Real",
  "type": "currency",
  "code": "BRL",
  "status": {
    "code": "ACTIVE",
    "description": "Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes"
  },
  "metadata": {
    "symbol": "R$",
    "country": "Brazil",
    "isoNumeric": "986",
    "supportsFractions": true,
    "decimalPlaces": 2,
    "category": "fiat",
    "environment": "production",
    "createdBy": "system",
    "notes": "Standard BRL currency asset for retail banking and Pix operations"
  }
}
'

import requests

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

payload = {
    "name": "Brazilian Real",
    "type": "currency",
    "code": "BRL",
    "status": {
        "code": "ACTIVE",
        "description": "Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes"
    },
    "metadata": {
        "symbol": "R$",
        "country": "Brazil",
        "isoNumeric": "986",
        "supportsFractions": True,
        "decimalPlaces": 2,
        "category": "fiat",
        "environment": "production",
        "createdBy": "system",
        "notes": "Standard BRL currency asset for retail banking and Pix operations"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Brazilian Real',
    type: 'currency',
    code: 'BRL',
    status: {
      code: 'ACTIVE',
      description: 'Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes'
    },
    metadata: {
      symbol: 'R$',
      country: 'Brazil',
      isoNumeric: '986',
      supportsFractions: true,
      decimalPlaces: 2,
      category: 'fiat',
      environment: 'production',
      createdBy: 'system',
      notes: 'Standard BRL currency asset for retail banking and Pix operations'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets', 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}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Brazilian Real',
    'type' => 'currency',
    'code' => 'BRL',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes'
    ],
    'metadata' => [
        'symbol' => 'R$',
        'country' => 'Brazil',
        'isoNumeric' => '986',
        'supportsFractions' => true,
        'decimalPlaces' => 2,
        'category' => 'fiat',
        'environment' => 'production',
        'createdBy' => 'system',
        'notes' => 'Standard BRL currency asset for retail banking and Pix operations'
    ]
  ]),
  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}/assets"

	payload := strings.NewReader("{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\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",
  "name": "<string>",
  "code": "<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"
}

Crear un Activo

Utilice este endpoint para crear el Activo que se utilizará con las transacciones. Puede crear múltiples Activos. Sin embargo, los Activos deben crearse uno a la vez, y cada Activo requiere configuraciones específicas de lugares decimales y otros parámetros individuales que deben definirse durante el proceso de creación.

Código de activo: debe consistir únicamente en letras mayúsculas (A-Z). Esto se aplica a todos los tipos de activos, no solo a las monedas; los códigos que contengan dígitos o símbolos serán rechazados.

Efecto secundario: crear un Activo aprovisiona automáticamente una cuenta externa dedicada (alias @external/<CODE>, tipo external) junto con su saldo predeterminado. Estos recursos gestionados por el sistema respaldan los movimientos externos (fuera del libro mayor) del activo.

POST

organizations

{organization_id}

ledgers

{ledger_id}

assets

Crear un Activo

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Brazilian Real",
  "type": "currency",
  "code": "BRL",
  "status": {
    "code": "ACTIVE",
    "description": "Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes"
  },
  "metadata": {
    "symbol": "R$",
    "country": "Brazil",
    "isoNumeric": "986",
    "supportsFractions": true,
    "decimalPlaces": 2,
    "category": "fiat",
    "environment": "production",
    "createdBy": "system",
    "notes": "Standard BRL currency asset for retail banking and Pix operations"
  }
}
'

import requests

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

payload = {
    "name": "Brazilian Real",
    "type": "currency",
    "code": "BRL",
    "status": {
        "code": "ACTIVE",
        "description": "Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes"
    },
    "metadata": {
        "symbol": "R$",
        "country": "Brazil",
        "isoNumeric": "986",
        "supportsFractions": True,
        "decimalPlaces": 2,
        "category": "fiat",
        "environment": "production",
        "createdBy": "system",
        "notes": "Standard BRL currency asset for retail banking and Pix operations"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Brazilian Real',
    type: 'currency',
    code: 'BRL',
    status: {
      code: 'ACTIVE',
      description: 'Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes'
    },
    metadata: {
      symbol: 'R$',
      country: 'Brazil',
      isoNumeric: '986',
      supportsFractions: true,
      decimalPlaces: 2,
      category: 'fiat',
      environment: 'production',
      createdBy: 'system',
      notes: 'Standard BRL currency asset for retail banking and Pix operations'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets', 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}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Brazilian Real',
    'type' => 'currency',
    'code' => 'BRL',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes'
    ],
    'metadata' => [
        'symbol' => 'R$',
        'country' => 'Brazil',
        'isoNumeric' => '986',
        'supportsFractions' => true,
        'decimalPlaces' => 2,
        'category' => 'fiat',
        'environment' => 'production',
        'createdBy' => 'system',
        'notes' => 'Standard BRL currency asset for retail banking and Pix operations'
    ]
  ]),
  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}/assets"

	payload := strings.NewReader("{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/assets")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Brazilian Real\",\n  \"type\": \"currency\",\n  \"code\": \"BRL\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Activo fiduciario principal utilizado para liquidación doméstica y saldos de clientes\"\n  },\n  \"metadata\": {\n    \"symbol\": \"R$\",\n    \"country\": \"Brazil\",\n    \"isoNumeric\": \"986\",\n    \"supportsFractions\": true,\n    \"decimalPlaces\": 2,\n    \"category\": \"fiat\",\n    \"environment\": \"production\",\n    \"createdBy\": \"system\",\n    \"notes\": \"Standard BRL currency asset for retail banking and Pix operations\"\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",
  "name": "<string>",
  "code": "<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.

Cuerpo

application/json

name

string

requerido

El nombre del Activo, que debe ser único.

Maximum string length: 256

type

enum<string>

requerido

El tipo de Activo.

Opciones disponibles:

currency,

crypto,

commodity,

others

code

string

requerido

El código utilizado para referirse al Activo, según su tipo. El código debe consistir únicamente en letras mayúsculas (A-Z); los dígitos y símbolos serán rechazados. Importante: No es posible crear activos con el mismo tipo y código. Además, si el Activo es una moneda (type = currency), el código debe seguir los valores de la norma ISO 4217.

Maximum string length: 100

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

organizationId

string<uuid>

El identificador único de la Organización.

ledgerId

string<uuid>

El identificador único del Ledger.

name

string

El nombre del Activo.

Maximum string length: 256

type

enum<string>

El tipo de Activo.

Opciones disponibles:

currency,

crypto,

commodity,

others

code

string

El código utilizado para referirse al Activo.

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

Actualizar configuraciones del Ledger

Listar Activos

⌘I

Primeros pasos

API de Organizaciones

API de Ledgers

API de Activos

API de Tipos de Cuenta

API de Cuentas

API de Portafolios

API de Segmentos

API de Saldos

API de Transacciones

API de Operaciones

API de Rutas de Operación

API de Rutas de Transacción

API de Índices de Metadatos

API de Titulares

API de Instrumentos

API de Paquetes de Facturación

API de Paquetes

API de Cálculo de Facturación

API de Estimación

API de Cifrado

API de Protección

API de Tasas de Activos

Manejo de errores

Fees Engine

Crear un Activo

Encabezados

Parámetros de ruta

Cuerpo

Respuesta