Crear un paquete

curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '{
  "feeGroupLabel": "Paquete estándar",
  "description": "Paquete para pruebas",
  "transactionRoute": "b2d91a9f-a369-4d8f-9116-660493b528ab",
  "segmentId": "0197d237-c31d-74de-ab9a-8f6c4c210b97",
  "ledgerId": "0197d1fb-4687-75b7-9615-a6547695ee6e",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tasa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees",
      "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
      "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": true
}'

{
  "id": "0196251d-a93a-7c42-9eef-c9f463470e21",
  "feeGroupLabel": "Paquete estándar",
  "description": "Paquete para pruebas",
  "transactionRoute": "b2d91a9f-a369-4d8f-9116-660493b528ab",
  "segmentId": "0197d237-c31d-74de-ab9a-8f6c4c210b97",
  "ledgerId": "0197d1fb-4687-75b7-9615-a6547695ee6e",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tasa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees",
      "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
      "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": true,
  "createdAt": "2025-04-10T07:33:03.121Z",
  "updatedAt": null,
  "deletedAt": null
}

POST

packages

Crear un paquete

curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/packages \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '{
  "feeGroupLabel": "Paquete estándar",
  "description": "Paquete para pruebas",
  "transactionRoute": "b2d91a9f-a369-4d8f-9116-660493b528ab",
  "segmentId": "0197d237-c31d-74de-ab9a-8f6c4c210b97",
  "ledgerId": "0197d1fb-4687-75b7-9615-a6547695ee6e",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tasa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees",
      "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
      "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": true
}'

{
  "id": "0196251d-a93a-7c42-9eef-c9f463470e21",
  "feeGroupLabel": "Paquete estándar",
  "description": "Paquete para pruebas",
  "transactionRoute": "b2d91a9f-a369-4d8f-9116-660493b528ab",
  "segmentId": "0197d237-c31d-74de-ab9a-8f6c4c210b97",
  "ledgerId": "0197d1fb-4687-75b7-9615-a6547695ee6e",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "@acc001",
    "@acc002",
    "@acc003"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tasa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "@fees",
      "routeFrom": "d35a121f-a638-4d2d-966b-65657a049f12",
      "routeTo": "d35a121f-a638-4d2d-966b-65657a049f12"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "@iof"
    }
  },
  "enable": true,
  "createdAt": "2025-04-10T07:33:03.121Z",
  "updatedAt": null,
  "deletedAt": null
}

Headers

X-Organization-Id

string

required

Identificador único de la organización asociada a la solicitud.

Example:

"0195fb87-eeb6-7487-bc58-659255a23ef1"

Authorization

string

The authorization token in the 'Bearer <token>' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

Content-Type

string

required

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

Example:

"application/json"

Body

application/json

feeGroupLabel

string

required

Nombre del grupo de tarifas, usado para identificar el paquete configurado.

ledgerId

string

required

Identificador único del Ledger al que está vinculado el paquete en el Ledger de Midaz.

minimumAmount

string

required

Monto mínimo de la transacción por debajo del cual las tarifas del paquete no aplican. Importante: usa un punto (.) como separador decimal; las comas no se aceptan.

maximumAmount

string

required

Monto máximo de la transacción por encima del cual las tarifas del paquete no aplican. Importante: usa un punto (.) como separador decimal; las comas no se aceptan.

fees

object

required

Objeto que contiene reglas de tarifas con nombres personalizados. Cada clave la define el cliente (por ejemplo, admFee, iof) y su valor debe seguir el esquema del objeto Fee.

Mostrar atributos secundarios

enable

boolean

required

Si true, indica que el paquete está activo.

description

string

Breve resumen del paquete que explica qué cubre.

transactionRoute

string

La ruta contable principal que define la naturaleza de la transacción. Ayuda a agrupar operaciones relacionadas en el Ledger.

segmentId

string

Identificador único del segmento al que está vinculado el paquete en el Ledger de Midaz.

waivedAccounts

string[]

Lista de cuentas exentas de las tarifas definidas en el paquete.

Response

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

string

required

Identificador único del paquete en formato UUIDv7.

feeGroupLabel

string

required

Nombre del grupo de tarifas, usado para identificar el paquete configurado.

ledgerId

string

required

Identificador único del Ledger al que está vinculado este paquete de tarifas en el Ledger de Midaz.

minimumAmount

string

required

Monto mínimo de la transacción por debajo del cual las tarifas del paquete no aplican.

maximumAmount

string

required

Monto máximo de la transacción por encima del cual las tarifas del paquete no aplican.

fees

object

required

Objeto que contiene reglas de tarifas con nombres personalizados. Cada clave la define el cliente (por ejemplo, admFee, iof) y su valor debe seguir el esquema del objeto Fee.

Mostrar atributos secundarios

enable

boolean

required

Si true, indica que el paquete está activo.

description

string

Breve resumen del paquete que explica qué cubre.

transactionRoute

string

La ruta contable principal que define la naturaleza de la transacción. Ayuda a agrupar operaciones relacionadas en el Ledger.

segmentId

string

Identificador único del segmento al que está vinculado este paquete de tarifas en el Ledger de Midaz.

waivedAccounts

string[]

Lista de cuentas exentas de las tarifas definidas en el paquete.

createdAt

string<date-time>

Fecha en la que se creó el paquete.

updatedAt

string<date-time>

Fecha en la que se actualizó por última vez el paquete.

deletedAt

string<date-time>

Fecha en la que se eliminó el paquete.

Lista de errores de CRM

Obtener un paquete

⌘I

CRM

Fees Engine

Pix Directo (en desarrollo)

Crear un paquete

Headers

Body

Response