Pular para o conteúdo principal
POST
/
v1
/
estimates
Estimar Taxas de Transação
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
            }
          ]
        }
      }
    }
  }
}

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
​
packageId
string
obrigatório

Identificador único do pacote que você deseja utilizar.

​
ledgerId
string
obrigatório

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

​
transaction
object
obrigatório

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

Resposta

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

Resultado da estimativa de taxas. message é sempre retornado com o resultado da avaliação. feesApplied é null quando nenhuma regra de taxa ou de gratuidade corresponde à requisição (por exemplo, em casos de gratuidade ou quando nenhuma regra se aplica); caso contrário, contém a transação estimada enriquecida com as taxas.

​
message
string
obrigatório

Resultado da avaliação de taxas. Se nenhuma regra correspondente for encontrada, fornece uma mensagem informativa.

​
feesApplied
object

Transação estimada com as taxas aplicadas, ou null quando nenhuma regra de taxa ou de gratuidade corresponde.