Skip to main content
POST
/
v1
/
estimates
Estimate Transaction Fees
curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/estimates \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "packageId": "0196251d-a93a-7c42-9eef-c9f463470e21",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "transaction": {
    "chartOfAccountsGroupName": "pix",
    "description": "Test FEE",
    "route": "pix",
    "pending": false,
    "send": {
      "asset": "BRL",
      "value": "4000.00",
      "source": {
        "from": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "customer-brl-1",
            "description": "New Transaction"
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "business-brl-5",
            "description": "New Transaction"
          }
        ]
      }
    }
  }
}
'
{
  "message": "Successfully estimated fee.",
  "feesApplied": {
    "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f",
    "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
    "transaction": {
      "route": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
      "description": "Fee Example",
      "pending": false,
      "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.

Headers

​
Authorization
string

The authorization token in the 'Bearer ' 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

The type of media of the resource. Must be application/json.

Example:

"application/json"

​
X-Organization-Id
string
required

The unique identifier of the Organization associated with the request.

Example:

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

Body

application/json
​
packageId
string
required

Unique identifier of the package that you want to use.

​
ledgerId
string
required

Unique identifier of the Ledger the package is linked to in the Midaz Ledger.

​
transaction
object
required

Information about the transaction to which the fee applies.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Result of the fee estimation. message is always returned with the result of the evaluation. feesApplied is null when no fee or gratuity rule matches the request (for example, on gratuity or when no rules apply); otherwise it contains the estimated transaction enriched with fees.

​
message
string
required

Result of the fee evaluation. If no matching rules are found, it provides an informational message.

​
feesApplied
object

Estimated transaction with the fees applied, or null when no fee or gratuity rule matches.