Saltar al contenido principal
POST
/
v1
/
config
/
fee-schedules
/
{scheduleId}
/
simulate
Simulate fee calculation
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/config/fee-schedules/{scheduleId}/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "grossAmount": "100.00",
  "currency": "USD"
}
'
{
  "grossAmount": "100.00",
  "netAmount": "97.70",
  "totalFee": "2.30",
  "currency": "USD",
  "items": [
    {
      "name": "interchange",
      "fee": "1.50",
      "baseUsed": "100.00"
    }
  ]
}

Autorizaciones

​
Authorization
string
header
requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

​
X-Request-Id
string

A unique identifier for tracing the request across services.

​
X-Idempotency-Key
string

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Parámetros de ruta

​
scheduleId
string
requerido

The unique identifier of the fee schedule.

Cuerpo

application/json

Fee simulation payload

Payload for simulating fee calculation against a fee schedule

​
grossAmount
string
requerido

Gross transaction amount to simulate fees on

Ejemplo:

"100.00"

​
currency
string
requerido

Currency code (ISO 4217)

Ejemplo:

"USD"

Respuesta

Fee simulation result.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

Result of a fee simulation

​
grossAmount
string

Original gross amount

Ejemplo:

"100.00"

​
netAmount
string

Amount after fees are deducted

Ejemplo:

"97.70"

​
totalFee
string

Total fee amount

Ejemplo:

"2.30"

​
currency
string

Currency code (ISO 4217)

Ejemplo:

"USD"

​
items
object[]

Breakdown of individual fee items

Maximum array length: 100