POST
/
v1
/
estimates
Simulate Transaction Fees
curl --request POST \
  --url https://fees.sandbox.midaz.io/v1/estimates \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '{
  "packageId": "0196251d-a93a-7c42-9eef-c9f463470e21",
  "ledgerId": "01962515-e02a-7eac-b616-5d0df19c3400",
  "transaction": {
    "description": "Test FEE",
    "route": "pix",
    "send": {
      "asset": "BRL",
      "value": "4000.00",
      "source": {
        "from": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "@account1",
            "description": "New Transaction"
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "@account10",
            "description": "New Transaction"
          }
        ]
      }
    }
  }
}'
{
  "segmentId": "0197f4cd-ea30-7840-95f6-f0c29a8b1c8c",
  "ledgerId": "01962515-e02a-7eac-b616-5d0df19c3400",
  "transaction": {
    "route": "b2d91a9f-a369-4d8f-9116-660493b528ab",
    "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
          },
          {
            "account": "@account3",
            "amount": {
              "asset": "BRL",
              "value": "1000.00"
            },
            "route": "pixdebit",
            "metadata": null
          },
          {
            "account": "@account4",
            "amount": {
              "asset": "BRL",
              "value": "1175.00"
            },
            "route": "pixdebit",
            "metadata": null
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "account": "@account5",
            "amount": {
              "asset": "BRL",
              "value": "4175.00"
            },
            "route": "pixcredit",
            "metadata": null
          }
        ]
      }
    }
  }
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Acces Manager plugin enabled.

​
Content-Type
string
required

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

​
X-Organization-Id
string
required

The unique identifier of the Organization associated with the request.

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.

​
segmentId
string
required

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

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