Pular para o conteúdo principal
POST
/
v1
/
packages
Criar um Pacote
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": "Standard Package",
  "description": "Package for testing",
  "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": "Administrative Fee",
      "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": "Standard Package", "description": "Package for testing", "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": "Administrative Fee", "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 }

Cabeçalhos

​
X-Organization-Id
string
obrigatório

O identificador único da Organização associada à requisição.

Exemplo:

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

​
Authorization
string

O token de autorização no formato 'Bearer '. Importante: Este header é obrigatório se o seu ambiente possui o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

Exemplo:

"application/json"

Corpo

application/json
​
feeGroupLabel
string
obrigatório

Nome do grupo de taxas, utilizado para identificar o pacote de taxas configurado.

​
ledgerId
string
obrigatório

Identificador único do Ledger ao qual o pacote está vinculado no Midaz Ledger.

​
minimumAmount
string
obrigatório

Valor mínimo da transação abaixo do qual as taxas do pacote não se aplicam. Importante: Use ponto (.) como separador decimal — vírgulas não são aceitas.

​
maximumAmount
string
obrigatório

Valor máximo da transação acima do qual as taxas do pacote não se aplicam. Importante: Use ponto (.) como separador decimal — vírgulas não são aceitas.

​
fees
object
obrigatório

Objeto contendo regras de taxas com nomes personalizados. Cada chave é definida pelo cliente (ex., admFee, iof) e seu valor deve seguir o schema do objeto Fee.

​
enable
boolean
obrigatório

Se true, indica que o pacote está ativo.

​
description
string

Resumo breve do pacote explicando o que ele abrange.

​
transactionRoute
string

A rota contábil principal que define a natureza da transação. Ajuda a agrupar operações relacionadas no ledger.

​
segmentId
string

Identificador único do Segmento ao qual o pacote está vinculado no Midaz Ledger.

​
waivedAccounts
string[]

Lista de contas que estão isentas das taxas definidas no pacote.

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
id
string
obrigatório

Identificador único do pacote, no formato UUIDv7.

​
feeGroupLabel
string
obrigatório

Nome do grupo de taxas, utilizado para identificar o pacote de taxas configurado.

​
ledgerId
string
obrigatório

Identificador único do Ledger ao qual este Pacote de Taxas está vinculado no Midaz Ledger.

​
minimumAmount
string
obrigatório

Valor mínimo da transação abaixo do qual as taxas do pacote não se aplicam.

​
maximumAmount
string
obrigatório

Valor máximo da transação acima do qual as taxas do pacote não se aplicam.

​
fees
object
obrigatório

Objeto contendo regras de taxas com nomes personalizados. Cada chave é definida pelo cliente (ex., admFee, iof) e seu valor deve seguir o schema do objeto Fee.

​
enable
boolean
obrigatório

Se true, indica que o pacote está ativo.

​
description
string

Resumo breve do pacote explicando o que ele abrange.

​
transactionRoute
string

A rota contábil principal que define a natureza da transação. Ajuda a agrupar operações relacionadas no ledger.

​
segmentId
string

Identificador único do Segmento ao qual este Pacote de Taxas está vinculado no Midaz Ledger.

​
waivedAccounts
string[]

Lista de contas que estão isentas das taxas definidas no pacote.

​
createdAt
string<date-time>

Data em que o pacote foi criado.

​
updatedAt
string<date-time>

Data em que o pacote foi atualizado pela última vez.

​
deletedAt
string<date-time>

Data em que o pacote foi excluído.