> ## 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. # 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. ## OpenAPI ````yaml /pt/openapi/v3-current/matcher.yaml post /v1/fee-schedules/{scheduleId}/simulate openapi: 3.1.0 info: title: Matcher APIs description: >- Complete API reference for the Matcher reconciliation engine, providing automated transaction matching between Midaz Ledger and external systems. version: 6.1.0 license: name: Lerian Studio General License servers: - url: https://matcher.sandbox.lerian.net security: [] paths: /v1/fee-schedules/{scheduleId}/simulate: post: tags: - Configuration Fee Schedules summary: Simulate fee calculation description: >- 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. operationId: simulateFeeSchedule parameters: - description: A unique identifier for tracing the request across services. in: header name: X-Request-Id schema: type: string - description: The unique identifier of the fee schedule. in: path name: scheduleId required: true schema: description: Schedule ID format: uuid type: string - $ref: '#/components/parameters/XIdempotency' requestBody: content: application/json: schema: $ref: '#/components/schemas/SimulateFeeRequest' description: Fee simulation payload required: true responses: '200': description: Fee simulation result. content: application/json: schema: $ref: '#/components/schemas/SimulateFeeResponse' headers: X-Idempotency-Replayed: $ref: '#/components/headers/XIdempotencyReplayed' '400': description: Invalid request payload content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: 400-invalid-gross-amount: $ref: '#/components/examples/400-invalid-gross-amount' mtch-0001-gross-currency-invalid-currency: $ref: >- #/components/examples/mtch-0001-gross-currency-invalid-currency '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Fee schedule not found content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: mtch-0115-fee-schedule-not-found: $ref: '#/components/examples/mtch-0115-fee-schedule-not-found' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' security: - BearerAuth: [] components: parameters: XIdempotency: name: X-Idempotency in: header required: false description: >- 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` (`MTCH-0018`), a key whose earlier attempt already ran but whose answer cannot be replayed returns `409` (`MTCH-0022`), and an idempotency storage failure returns `500`. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents. schema: type: string schemas: SimulateFeeRequest: additionalProperties: false properties: currency: description: ISO 4217 currency code of the gross amount. examples: - USD type: string grossAmount: description: >- Gross amount to simulate fees against, as a decimal string in the given currency. examples: - '100.00' type: string required: - grossAmount - currency type: object SimulateFeeResponse: additionalProperties: false properties: currency: description: ISO 4217 currency code of the simulated amounts. examples: - USD type: string grossAmount: description: Gross amount that fees were simulated against, as a decimal string. examples: - '100.00' type: string items: description: Per-item breakdown of the simulated fees. items: $ref: '#/components/schemas/SimulateFeeItem' maxItems: 100 type: - array - 'null' netAmount: description: Amount remaining after all fees, as a decimal string. examples: - '97.70' type: string totalFee: description: Sum of all item fees, as a decimal string. examples: - '2.30' type: string required: - grossAmount - netAmount - totalFee - currency - items type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object SimulateFeeItem: additionalProperties: false properties: baseUsed: description: Base amount this item's fee was computed from, as a decimal string. examples: - '100.00' type: string fee: description: Fee charged by this item, as a decimal string. examples: - '1.50' type: string name: description: Name of the fee item. examples: - interchange type: string required: - name - fee - baseUsed type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object RateLimitErrorResponse: description: >- Flat body that the rate limiter returns. `code` is the HTTP status as a number. type: object required: - code - title - message properties: code: type: integer description: HTTP status code. example: 429 title: type: string description: Error type. example: rate_limit_exceeded message: type: string description: Human-readable error message. example: rate limit exceeded headers: XIdempotencyReplayed: description: >- Indicates whether this response was served from the idempotency cache. When `true`, the response is a replay of the original request with the same idempotency key. schema: type: boolean RetryAfter: description: Seconds to wait before you retry. schema: type: integer example: 30 XRateLimitLimit: description: Requests allowed in the current window. schema: type: integer example: 100 XRateLimitRemaining: description: Requests left in the current window. Always `0` on a `429`. schema: type: integer example: 0 XRateLimitReset: description: Unix time, in seconds, when the current window resets. schema: type: integer example: 1767225600 examples: 400-invalid-gross-amount: summary: Invalid gross amount value: type: https://errors.lerian.studio/v1/MTCH-0001 title: Bad Request status: 400 detail: >- The gross amount is not a valid decimal number. Check the amount and try again. code: MTCH-0001 mtch-0001-gross-currency-invalid-currency: summary: 'Gross currency: invalid currency' value: type: https://errors.lerian.studio/v1/MTCH-0001 title: Bad Request status: 400 detail: >- The simulation could not run for this schedule; the cause may be the gross amount or currency you provided, how the schedule's own fee items are configured, or — if the schedule includes an expression-based fee — the fact that a standalone simulation carries no transaction metadata for that expression to evaluate. Check those settings, or simulate against a real transaction instead, then try again. code: MTCH-0001 mtch-0115-fee-schedule-not-found: summary: Fee schedule not found value: type: https://errors.lerian.studio/v1/MTCH-0115 title: Not Found status: 404 detail: >- The fee schedule could not be found; check the fee schedule id and try again code: MTCH-0115 responses: Unauthorized: description: The request lacks valid authentication credentials. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: MissingToken: summary: Missing token value: type: https://errors.lerian.studio/v1/AUT-0006 title: Token Missing status: 401 detail: >- A valid token must be provided in the request header. Please include a token and try again. code: AUT-0006 InvalidToken: summary: Invalid token value: type: https://errors.lerian.studio/v1/AUT-0007 title: Invalid Token status: 401 detail: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. code: AUT-0007 Forbidden: description: You do not have permission to access this resource. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: TenantClaimRequired: summary: Tenant claim missing value: type: https://errors.lerian.studio/v1/MTCH-0004 title: Forbidden status: 403 detail: tenant claim required code: MTCH-0004 PermissionDenied: summary: Permission denied value: type: https://errors.lerian.studio/v1/AUT-1020 title: Permission Denied status: 403 detail: >- the credential is not allowed to perform contexts:read on this request code: AUT-1020 ValidationFailed: description: >- The request failed validation. The `errors` list names each value that failed. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: title: Unprocessable Entity status: 422 detail: validation failed errors: - message: expected required property name to be present location: body TooManyRequests: description: >- The request exceeded the rate limit. Wait the number of seconds in `Retry-After`, then retry. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' example: code: 429 title: rate_limit_exceeded message: rate limit exceeded InternalServerError: description: An unexpected error occurred on the server. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: type: https://errors.lerian.studio/v1/MTCH-0002 title: Internal Server Error status: 500 detail: internal error code: MTCH-0002 text/plain: schema: type: string example: Internal Server Error securitySchemes: BearerAuth: bearerFormat: JWT description: 'Bearer token authentication (format: "Bearer {token}")' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.