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": "0197d237-c31d-74de-ab9a-8f6c4c210b97",
  "ledgerId": "0197d1fb-4687-75b7-9615-a6547695ee6e",
  "transaction": {
    "route": "b2d91a9f-a369-4d8f-9116-660493b528ab",
    "description": "Fee test",
    "pending": false,
    "send": {
      "asset": "BRL",
      "value": "4000.00",
      "source": {
        "from": [
          {
            "accountAlias": "@testfee1",
            "share": {
              "percentage": "15"
            }
          },
          {
            "accountAlias": "@testfee2",
            "share": {
              "percentage": "35"
            }
          },
          {
            "accountAlias": "@testfee3",
            "share": {
              "percentage": "40"
            }
          },
          {
            "accountAlias": "@testfee4",
            "share": {
              "percentage": "10"
            }
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "accountAlias": "@testfee5",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "@testfee6",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "@testfee7",
            "share": {
              "percentage": "25"
            }
          },
          {
            "accountAlias": "@testfee8",
            "share": {
              "percentage": "25"
            }
          }
        ]
      }
    }
  }
}
'
{ "id": "c62c6564-17fb-4eb6-b57b-4bc27c42b06b", "segmentId": "ecd2ac18-920e-4438-9f84-208eac050c8a", "ledgerId": "ac0cd8b8-55e1-4695-8b50-67868aa5f334", "transaction": { "route": "b2d91a9f-a369-4d8f-9116-660493b528ab", "pending": false, "description": "Fee Example", "metadata": { "packageAppliedID": "01962565-8d57-737b-abfa-84c3a15eeb15" }, "send": { "asset": "BRL", "value": "4175.00", "source": { "from": [ { "accountAlias": "@account1", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "@account2", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "@account3", "amount": { "asset": "BRL", "value": "1000.00" }, "route": "pixdebit", "metadata": null }, { "accountAlias": "@account4", "amount": { "asset": "BRL", "value": "1175.00" }, "route": "pixdebit", "metadata": null } ] }, "distribute": { "to": [ { "accountAlias": "@account5", "amount": { "asset": "BRL", "value": "4175.00" }, "route": "pixcredit", "metadata": null } ] } } } }

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:

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

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.

​
id
string
obrigatório

Identificador único do cálculo, no formato UUIDv7.

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