Saltar al contenido principal
POST
/
v1
/
estimates
Estimar comisión por transacción
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": "Tarifa de prueba",
    "route": "pix",
    "pending": false,
    "send": {
      "asset": "BRL",
      "value": "4000.00",
      "source": {
        "from": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "customer-brl-1",
            "description": "Nueva transacción"
          }
        ]
      },
      "distribute": {
        "to": [
          {
            "amount": {
              "asset": "BRL",
              "value": "4000.00"
            },
            "accountAlias": "business-brl-5",
            "description": "Nueva transacción"
          }
        ]
      }
    }
  }
}
'
{ "message": "Tarifa estimada correctamente.", "feesApplied": { "segmentId": "019c96a0-0b4e-7079-8be0-ab6bdccf975f", "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a", "transaction": { "route": "019c96a0-10a0-72d2-9fb0-2b7de8093182", "description": "Ejemplo de tarifa", "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.

Encabezados

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

Ejemplo:

"application/json"

​
X-Organization-Id
string
requerido

Identificador único de la organización asociada a la solicitud.

Ejemplo:

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

Cuerpo

application/json
​
packageId
string
requerido

Identificador único del paquete que deseas usar.

​
ledgerId
string
requerido

Identificador único del Ledger al que está vinculado el paquete en el Ledger de Midaz.

​
transaction
object
requerido

Información sobre la transacción a la que se aplica la tarifa.

Respuesta

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

Resultado de la estimación de tarifas. message siempre se devuelve con el resultado de la evaluación. feesApplied es null cuando ninguna regla de tarifa o de gratuidad coincide con la solicitud (por ejemplo, en caso de gratuidad o cuando no se aplica ninguna regla); en caso contrario contiene la transacción estimada enriquecida con las tarifas.

​
message
string
requerido

Resultado de la evaluación de tarifas. Si no se encuentran reglas coincidentes, proporciona un mensaje informativo.

​
feesApplied
object

Transacción estimada con las tarifas aplicadas, o null cuando ninguna regla de tarifa o de gratuidad coincide.