v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Fee Schedules

Simulate fee calculation

Use this endpoint to simulate fee calculation for a given gross amount using a specific fee schedule. Returns the net amount, total fee, and per-item breakdown.

post/v1/fee-schedules/{scheduleId}/simulate

Path parameters

scheduleIdstring required

The unique identifier of the fee schedule.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

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.

Request body

grossAmountstring required

Gross transaction amount to simulate fees on

currencystring required

Currency code (ISO 4217)

Example request

{
  "grossAmount": "100.00",
  "currency": "USD"
}

Response

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.

grossAmountstring

Original gross amount

netAmountstring

Amount after fees are deducted

totalFeestring

Total fee amount

currencystring

Currency code (ISO 4217)

Example response

{
  "grossAmount": "100.00",
  "netAmount": "97.70",
  "totalFee": "2.30",
  "currency": "USD",
  "items": [
    {
      "name": "interchange",
      "fee": "1.50",
      "baseUsed": "100.00"
    }
  ]
}