Skip to main content
POST
Simulate fee calculation

Authorizations

Authorization
string
header
required

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

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency
string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

scheduleId
string<uuid>
required

The unique identifier of the fee schedule. Schedule ID

Body

application/json

Fee simulation payload

currency
string
required

ISO 4217 currency code of the gross amount.

Example:

"USD"

grossAmount
string
required

Gross amount to simulate fees against, as a decimal string in the given currency.

Example:

"100.00"

Response

Fee simulation result.

currency
string
required

ISO 4217 currency code of the simulated amounts.

Example:

"USD"

grossAmount
string
required

Gross amount that fees were simulated against, as a decimal string.

Example:

"100.00"

items
object[] | null
required

Per-item breakdown of the simulated fees.

Maximum array length: 100
netAmount
string
required

Amount remaining after all fees, as a decimal string.

Example:

"97.70"

totalFee
string
required

Sum of all item fees, as a decimal string.

Example:

"2.30"