Saltar al contenido principal
POST
/
v1
/
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": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
  "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "minimumAmount": "3000.00",
  "maximumAmount": "6000.00",
  "waivedAccounts": [
    "customer-brl-1",
    "customer-brl-2",
    "customer-brl-3"
  ],
  "fees": {
    "admFee": {
      "feeLabel": "Tasa administrativa",
      "calculationModel": {
        "applicationRule": "flatFee",
        "calculations": [
          {
            "type": "flat",
            "value": "16.00"
          }
        ]
      },
      "referenceAmount": "originalAmount",
      "priority": 1,
      "isDeductibleFrom": true,
      "creditAccount": "business-brl-1",
      "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252",
      "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed"
    },
    "iof": {
      "feeLabel": "IOF",
      "calculationModel": {
        "applicationRule": "percentual",
        "calculations": [
          {
            "type": "percentage",
            "value": "6.00"
          }
        ]
      },
      "referenceAmount": "afterFeesAmount",
      "priority": 2,
      "isDeductibleFrom": false,
      "creditAccount": "business-brl-2"
    }
  },
  "enable": true
}
'
{ "id": "0196251d-a93a-7c42-9eef-c9f463470e21", "feeGroupLabel": "Paquete estándar", "description": "Paquete para pruebas", "transactionRoute": "019c96a0-10a0-72d2-9fb0-2b7de8093182", "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f", "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a", "minimumAmount": "3000.00", "maximumAmount": "6000.00", "waivedAccounts": [ "customer-brl-1", "customer-brl-2", "customer-brl-3" ], "fees": { "admFee": { "feeLabel": "Tasa administrativa", "calculationModel": { "applicationRule": "flatFee", "calculations": [ { "type": "flat", "value": "16.00" } ] }, "referenceAmount": "originalAmount", "priority": 1, "isDeductibleFrom": true, "creditAccount": "business-brl-1", "routeFrom": "019c96a0-1071-7a0d-9916-a831221de252", "routeTo": "019c96a0-108c-7a74-8e31-3789daffe1ed" }, "iof": { "feeLabel": "IOF", "calculationModel": { "applicationRule": "percentual", "calculations": [ { "type": "percentage", "value": "6.00" } ] }, "referenceAmount": "afterFeesAmount", "priority": 2, "isDeductibleFrom": false, "creditAccount": "business-brl-2" } }, "enable": true, "createdAt": "2025-04-10T07:33:03.121Z", "updatedAt": null, "deletedAt": null }

Encabezados

​
X-Organization-Id
string
requerido

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

Ejemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
Content-Type
string
requerido

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

Ejemplo:

"application/json"

Cuerpo

application/json
​
feeGroupLabel
string
requerido

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

​
ledgerId
string
requerido

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

​
minimumAmount
string
requerido

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
requerido

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
requerido

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.

​
enable
boolean
requerido

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.

Respuesta

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

​
id
string
requerido

Identificador único del paquete en formato UUIDv7.

​
feeGroupLabel
string
requerido

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

​
ledgerId
string
requerido

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

​
minimumAmount
string
requerido

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

​
maximumAmount
string
requerido

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

​
fees
object
requerido

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.

​
enable
boolean
requerido

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.