Pular para o conteúdo principal
POST
/
v1
/
fees
Calcular Taxas de um Pacote
curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/fees \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "transaction": {
    "route": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
    "description": "Fee test",
    "pending": false,
    "send": {
      "asset": "BRL",
      "value": "4000.00",
      "source": {
        "from": [
          {
            "accountAlias": "customer-brl-1",
            "share": {
              "percentage": "15"
            }
          },
          {
            "accountAlias": "customer-brl-2",
            "share": {
              "percentage": "35"
            }
          },
          {
            "accountAlias": "customer-brl-3",
            "share": {
              "percentage": "40"
            }
          },
          {
            "accountAlias": "customer-brl-4",
            "share": {
              "percentage": "10"
            }
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "accountAlias": "business-brl-1",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "business-brl-2",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "business-brl-3",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "business-brl-4",
            "share": {
              "percentage": "25"
            }
          }
        ]
      }
    }
  }
}
'
{ "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f", "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a", "transaction": { "route": "019c96a0-10a0-72d2-9fb0-2b7de8093182", "pending": false, "description": "Fee Example", "metadata": { "packageAppliedID": "01962565-8d57-737b-abfa-84c3a15eeb15" }, "send": { "asset": "BRL", "value": "4175.00", "source": { "from": [ { "accountAlias": "customer-brl-1", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "customer-brl-2", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "customer-brl-3", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "customer-brl-4", "amount": { "asset": "BRL", "value": "1175.00" }, "route": "pixdebit", "metadata": null } ] }, "distribute": { "to": [ { "accountAlias": "business-brl-1", "amount": { "asset": "BRL", "value": "4175.00" }, "route": "pixcredit", "metadata": null } ] } } } }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Cabeçalhos

​
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"

​
X-Organization-Id
string
obrigatório

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

Exemplo:

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

Corpo

application/json
​
ledgerId
string
obrigatório

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

​
transaction
object
obrigatório

Informações sobre a transação à qual a taxa se aplica.

​
segmentId
string

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

Resposta

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

Resultado do cálculo de taxas. Contém os identificadores do Ledger e do Segmento junto com a transação enriquecida com as taxas calculadas.

​
ledgerId
string
obrigatório

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

​
transaction
object
obrigatório

Informações sobre a transação à qual a taxa se aplica.

​
segmentId
string

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