Crear un paquete

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/packages \
  --header 'Content-Type: application/json' \
  --data '
{
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enable": true,
  "feeGroupLabel": "<string>",
  "fees": {},
  "id": "<string>",
  "ledgerId": "<string>",
  "maximumAmount": "<string>",
  "minimumAmount": "<string>",
  "segmentId": "<string>",
  "transactionRoute": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "waivedAccounts": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "enable": True,
    "feeGroupLabel": "<string>",
    "fees": {},
    "id": "<string>",
    "ledgerId": "<string>",
    "maximumAmount": "<string>",
    "minimumAmount": "<string>",
    "segmentId": "<string>",
    "transactionRoute": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "waivedAccounts": ["<string>"]
}
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({
    createdAt: '2023-11-07T05:31:56Z',
    deletedAt: '2023-11-07T05:31:56Z',
    description: '<string>',
    enable: true,
    feeGroupLabel: '<string>',
    fees: {},
    id: '<string>',
    ledgerId: '<string>',
    maximumAmount: '<string>',
    minimumAmount: '<string>',
    segmentId: '<string>',
    transactionRoute: '<string>',
    updatedAt: '2023-11-07T05:31:56Z',
    waivedAccounts: ['<string>']
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/packages', 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}/packages",
  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([
    'createdAt' => '2023-11-07T05:31:56Z',
    'deletedAt' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'enable' => true,
    'feeGroupLabel' => '<string>',
    'fees' => [
        
    ],
    'id' => '<string>',
    'ledgerId' => '<string>',
    'maximumAmount' => '<string>',
    'minimumAmount' => '<string>',
    'segmentId' => '<string>',
    'transactionRoute' => '<string>',
    'updatedAt' => '2023-11-07T05:31:56Z',
    'waivedAccounts' => [
        '<string>'
    ]
  ]),
  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}/packages"

	payload := strings.NewReader("{\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\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}/packages")
  .header("Content-Type", "application/json")
  .body("{\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\n  ]\n}"

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enable": true,
  "feeGroupLabel": "<string>",
  "fees": {},
  "id": "<string>",
  "ledgerId": "<string>",
  "maximumAmount": "<string>",
  "minimumAmount": "<string>",
  "segmentId": "<string>",
  "transactionRoute": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "waivedAccounts": [
    "<string>"
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

organizations

{organization_id}

packages

Crear un paquete

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/packages \
  --header 'Content-Type: application/json' \
  --data '
{
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enable": true,
  "feeGroupLabel": "<string>",
  "fees": {},
  "id": "<string>",
  "ledgerId": "<string>",
  "maximumAmount": "<string>",
  "minimumAmount": "<string>",
  "segmentId": "<string>",
  "transactionRoute": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "waivedAccounts": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "enable": True,
    "feeGroupLabel": "<string>",
    "fees": {},
    "id": "<string>",
    "ledgerId": "<string>",
    "maximumAmount": "<string>",
    "minimumAmount": "<string>",
    "segmentId": "<string>",
    "transactionRoute": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "waivedAccounts": ["<string>"]
}
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({
    createdAt: '2023-11-07T05:31:56Z',
    deletedAt: '2023-11-07T05:31:56Z',
    description: '<string>',
    enable: true,
    feeGroupLabel: '<string>',
    fees: {},
    id: '<string>',
    ledgerId: '<string>',
    maximumAmount: '<string>',
    minimumAmount: '<string>',
    segmentId: '<string>',
    transactionRoute: '<string>',
    updatedAt: '2023-11-07T05:31:56Z',
    waivedAccounts: ['<string>']
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/packages', 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}/packages",
  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([
    'createdAt' => '2023-11-07T05:31:56Z',
    'deletedAt' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'enable' => true,
    'feeGroupLabel' => '<string>',
    'fees' => [
        
    ],
    'id' => '<string>',
    'ledgerId' => '<string>',
    'maximumAmount' => '<string>',
    'minimumAmount' => '<string>',
    'segmentId' => '<string>',
    'transactionRoute' => '<string>',
    'updatedAt' => '2023-11-07T05:31:56Z',
    'waivedAccounts' => [
        '<string>'
    ]
  ]),
  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}/packages"

	payload := strings.NewReader("{\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\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}/packages")
  .header("Content-Type", "application/json")
  .body("{\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"deletedAt\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"enable\": true,\n  \"feeGroupLabel\": \"<string>\",\n  \"fees\": {},\n  \"id\": \"<string>\",\n  \"ledgerId\": \"<string>\",\n  \"maximumAmount\": \"<string>\",\n  \"minimumAmount\": \"<string>\",\n  \"segmentId\": \"<string>\",\n  \"transactionRoute\": \"<string>\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"waivedAccounts\": [\n    \"<string>\"\n  ]\n}"

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

{
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "enable": true,
  "feeGroupLabel": "<string>",
  "fees": {},
  "id": "<string>",
  "ledgerId": "<string>",
  "maximumAmount": "<string>",
  "minimumAmount": "<string>",
  "segmentId": "<string>",
  "transactionRoute": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "waivedAccounts": [
    "<string>"
  ]
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

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.

Cuerpo

application/json

createdAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

description

string | null

requerido

Ejemplo:

"Pacote de taxas administrativas padrão"

enable

boolean | null

requerido

feeGroupLabel

string

requerido

Ejemplo:

"Pacote Padrão"

fees

object

requerido

Show child attributes

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

maximumAmount

string

requerido

Ejemplo:

"2"

minimumAmount

string

requerido

Ejemplo:

"100"

segmentId

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

transactionRoute

string | null

requerido

Ejemplo:

"debitoted"

updatedAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

waivedAccounts

string[] | null

requerido

Ejemplo:

["acc001", "acc002"]

Respuesta

createdAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

description

string | null

requerido

Ejemplo:

"Pacote de taxas administrativas padrão"

enable

boolean | null

requerido

feeGroupLabel

string

requerido

Ejemplo:

"Pacote Padrão"

fees

object

requerido

Show child attributes

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

maximumAmount

string

requerido

Ejemplo:

"2"

minimumAmount

string

requerido

Ejemplo:

"100"

segmentId

string

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

transactionRoute

string | null

requerido

Ejemplo:

"debitoted"

updatedAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

waivedAccounts

string[] | null

requerido

Ejemplo:

["acc001", "acc002"]

⌘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 paquete

Encabezados

Parámetros de ruta

Cuerpo

Respuesta