Saltar al contenido principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
operation-routes
Crear una Ruta de Operación
curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes \
  --header 'Content-Type: <content-type>' \
  --data '{
  "account": {
    "ruleType": "alias",
    "validIf": "@customer_brl_wallet"
  },
  "code": "EXT-001",
  "title": "Cobro de la comisión por servicio",
  "description": "Esta ruta operativa gestiona las transacciones de ingreso de efectivo procedentes del cobro de cargos por servicio",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "operationType": "source"
}'
{
  "id": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "organizationId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "ledgerId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@account1"
    ]
  },
  "code": "EXT-001",
  "description": "Esta ruta de operación gestiona transacciones de cobro por comisiones (cash-in)",
  "operationType": "source",
  "title": "Cobro por comisión (cash-in)",
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z"
}

Headers

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string

Identificador único usado para rastrear cada solicitud.

Path Parameters

​
organization_id
string
required

Identificador único de la organización asociada al ledger.

​
ledger_id
string
required

Identificador único del ledger asociado.

Body

application/json
​
title
string
required

Texto corto que resume el propósito de la operación. Se usa como nota de identificación.

Maximum length: 50
​
operationType
enum<string>
required

Tipo de la ruta de operación.

Opciones disponibles:
source,
destination
​
account
object

Define la regla para seleccionar la cuenta que participará en la operación (origen o destino).

​
code
string

Referencia externa utilizada para identificar la ruta de operación.

Maximum length: 100
​
description
string

Descripción detallada del propósito y uso de la ruta de operación.

Maximum length: 250
​
metadata
object

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 costos, usa 'costCenter': 'BR_11101997'.

Response

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

​
title
string
required

Texto corto que resume el propósito de la operación. Se usa como nota de identificación.

Maximum length: 50
​
operationType
enum<string>
required

Tipo de la ruta de operación.

Opciones disponibles:
source,
destination
​
account
object

Define la regla para seleccionar la cuenta que participará en la operación (origen o destino).

​
code
string

Referencia externa utilizada para identificar la ruta de operación.

Maximum length: 100
​
description
string

Descripción detallada del propósito y uso de la ruta de operación.

Maximum length: 250
​
metadata
object

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 costos, usa 'costCenter': 'BR_11101997'.