Crear un Segmento

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Accounts",
  "status": {
    "code": "ACTIVE",
    "description": "Segmento para cuentas de clientes"
  },
  "metadata": {
    "minMonthlyIncome": 10000,
    "creditScoreThreshold": 750,
    "tier": "Gold",
    "fxEnabled": true,
    "overdraftEligibility": true,
    "dailyTransferLimit": 50000,
    "segmentationSource": "internal_scoring_engine",
    "notes": "Applied automatically based on KYC score and account history"
  }
}
'

import requests

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

payload = {
    "name": "Customer Accounts",
    "status": {
        "code": "ACTIVE",
        "description": "Segmento para cuentas de clientes"
    },
    "metadata": {
        "minMonthlyIncome": 10000,
        "creditScoreThreshold": 750,
        "tier": "Gold",
        "fxEnabled": True,
        "overdraftEligibility": True,
        "dailyTransferLimit": 50000,
        "segmentationSource": "internal_scoring_engine",
        "notes": "Applied automatically based on KYC score and account history"
    }
}
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: 'Customer Accounts',
    status: {code: 'ACTIVE', description: 'Segmento para cuentas de clientes'},
    metadata: {
      minMonthlyIncome: 10000,
      creditScoreThreshold: 750,
      tier: 'Gold',
      fxEnabled: true,
      overdraftEligibility: true,
      dailyTransferLimit: 50000,
      segmentationSource: 'internal_scoring_engine',
      notes: 'Applied automatically based on KYC score and account history'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments', 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}/segments",
  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' => 'Customer Accounts',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Segmento para cuentas de clientes'
    ],
    'metadata' => [
        'minMonthlyIncome' => 10000,
        'creditScoreThreshold' => 750,
        'tier' => 'Gold',
        'fxEnabled' => true,
        'overdraftEligibility' => true,
        'dailyTransferLimit' => 50000,
        'segmentationSource' => 'internal_scoring_engine',
        'notes' => 'Applied automatically based on KYC score and account history'
    ]
  ]),
  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}/segments"

	payload := strings.NewReader("{\n  \"name\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\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}/segments")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\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>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

segments

Crear un Segmento

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Customer Accounts",
  "status": {
    "code": "ACTIVE",
    "description": "Segmento para cuentas de clientes"
  },
  "metadata": {
    "minMonthlyIncome": 10000,
    "creditScoreThreshold": 750,
    "tier": "Gold",
    "fxEnabled": true,
    "overdraftEligibility": true,
    "dailyTransferLimit": 50000,
    "segmentationSource": "internal_scoring_engine",
    "notes": "Applied automatically based on KYC score and account history"
  }
}
'

import requests

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

payload = {
    "name": "Customer Accounts",
    "status": {
        "code": "ACTIVE",
        "description": "Segmento para cuentas de clientes"
    },
    "metadata": {
        "minMonthlyIncome": 10000,
        "creditScoreThreshold": 750,
        "tier": "Gold",
        "fxEnabled": True,
        "overdraftEligibility": True,
        "dailyTransferLimit": 50000,
        "segmentationSource": "internal_scoring_engine",
        "notes": "Applied automatically based on KYC score and account history"
    }
}
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: 'Customer Accounts',
    status: {code: 'ACTIVE', description: 'Segmento para cuentas de clientes'},
    metadata: {
      minMonthlyIncome: 10000,
      creditScoreThreshold: 750,
      tier: 'Gold',
      fxEnabled: true,
      overdraftEligibility: true,
      dailyTransferLimit: 50000,
      segmentationSource: 'internal_scoring_engine',
      notes: 'Applied automatically based on KYC score and account history'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments', 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}/segments",
  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' => 'Customer Accounts',
    'status' => [
        'code' => 'ACTIVE',
        'description' => 'Segmento para cuentas de clientes'
    ],
    'metadata' => [
        'minMonthlyIncome' => 10000,
        'creditScoreThreshold' => 750,
        'tier' => 'Gold',
        'fxEnabled' => true,
        'overdraftEligibility' => true,
        'dailyTransferLimit' => 50000,
        'segmentationSource' => 'internal_scoring_engine',
        'notes' => 'Applied automatically based on KYC score and account history'
    ]
  ]),
  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}/segments"

	payload := strings.NewReader("{\n  \"name\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\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}/segments")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"Customer Accounts\",\n  \"status\": {\n    \"code\": \"ACTIVE\",\n    \"description\": \"Segmento para cuentas de clientes\"\n  },\n  \"metadata\": {\n    \"minMonthlyIncome\": 10000,\n    \"creditScoreThreshold\": 750,\n    \"tier\": \"Gold\",\n    \"fxEnabled\": true,\n    \"overdraftEligibility\": true,\n    \"dailyTransferLimit\": 50000,\n    \"segmentationSource\": \"internal_scoring_engine\",\n    \"notes\": \"Applied automatically based on KYC score and account history\"\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>",
  "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 Segmento.

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

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

organizationId

string<uuid>

El identificador único de la Organización.

ledgerId

string<uuid>

El identificador único del Ledger.

name

string

El nombre del Segmento.

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

Eliminar un Portafolio

Listar Segmentos

⌘I