Criar um Ativo

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": "Primary fiat asset used for domestic settlement and customer balances"
  },
  "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": "Primary fiat asset used for domestic settlement and customer balances"
    },
    "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: 'Primary fiat asset used for domestic settlement and customer balances'
    },
    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' => 'Primary fiat asset used for domestic settlement and customer balances'
    ],
    '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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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"
}

Criar um Ativo

Use este endpoint para criar o Ativo que será utilizado nas transações. Você pode criar múltiplos Ativos. No entanto, os Ativos devem ser criados um de cada vez, com cada Ativo exigindo configurações específicas de casas decimais e outros parâmetros individuais a serem definidos durante o processo de criação.

Código do ativo: deve conter apenas letras maiúsculas (A-Z). Isso se aplica a todos os tipos de ativo, não apenas a moedas; códigos contendo dígitos ou símbolos são rejeitados.

Efeito colateral: criar um Ativo provisiona automaticamente uma conta externa dedicada (alias @external/<CODE>, tipo external) junto com seu saldo padrão. Esses recursos gerenciados pelo sistema dão suporte a movimentações externas (fora do ledger) do ativo.

POST

organizations

{organization_id}

ledgers

{ledger_id}

assets

Criar um Ativo

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": "Primary fiat asset used for domestic settlement and customer balances"
  },
  "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": "Primary fiat asset used for domestic settlement and customer balances"
    },
    "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: 'Primary fiat asset used for domestic settlement and customer balances'
    },
    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' => 'Primary fiat asset used for domestic settlement and customer balances'
    ],
    '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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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\": \"Primary fiat asset used for domestic settlement and customer balances\"\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"
}

Cabeçalhos

Content-Type

string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id

string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

Corpo

application/json

name

string

obrigatório

O nome do Ativo, que deve ser único.

Maximum string length: 256

type

enum<string>

obrigatório

O tipo de Ativo.

Opções disponíveis:

currency,

crypto,

commodity,

others

code

string

obrigatório

O código utilizado para se referir ao Ativo, de acordo com seu tipo. O código deve conter apenas letras maiúsculas (A-Z); dígitos e símbolos são rejeitados. Importante: Não é possível criar ativos com o mesmo tipo e código. Além disso, se o Ativo for uma moeda (type = currency), o código deve seguir os valores da ISO 4217.

Maximum string length: 100

status

object

Um objeto contendo informações sobre o status. Importante: Se não fornecido, o status padrão será 'ACTIVE'.

Show child attributes

metadata

object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

Show child attributes

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

string<uuid>

O identificador único do Ativo.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

name

string

O nome do Ativo.

Maximum string length: 256

type

enum<string>

O tipo de Ativo.

Opções disponíveis:

currency,

crypto,

commodity,

others

code

string

O código usado para referenciar o Ativo.

status

object

Um objeto contendo informações sobre o status.

Show child attributes

metadata

object

Show child attributes

createdAt

string<date-time>

Data e hora de criação (UTC).

updatedAt

string<date-time>

Data e hora da última atualização (UTC).

deletedAt

string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).

Atualizar configurações do Ledger

Listar Ativos

⌘I