> ## 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. # Update a fee rule > Use this endpoint to update the fields of a specific fee rule by its identifier. If the referenced fee schedule changes, the caller must also be allowed to read that fee schedule. ## OpenAPI ````yaml /pt/openapi/v3-current/matcher.yaml patch /v1/fee-rules/{feeRuleId} 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: 5.0.4 license: name: Lerian Studio General License servers: - url: https://matcher.sandbox.lerian.net security: [] paths: /v1/fee-rules/{feeRuleId}: patch: tags: - Configuration Fee Rules summary: Update a fee rule description: >- Use this endpoint to update the fields of a specific fee rule by its identifier. If the referenced fee schedule changes, the caller must also be allowed to read that fee schedule. operationId: updateFeeRule 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 rule. in: path name: feeRuleId required: true schema: description: Fee Rule ID format: uuid type: string - $ref: '#/components/parameters/XIdempotency' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFeeRuleRequest' description: Fee rule updates required: true responses: '200': description: Successfully updated fee rule. content: application/json: schema: $ref: '#/components/schemas/FeeRuleResponse' headers: X-Idempotency-Replayed: $ref: '#/components/headers/XIdempotencyReplayed' '400': description: Invalid request payload content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: mtch-0001-update-fee-rule-fee-rule-name-fee-rule-name-is-required: $ref: >- #/components/examples/mtch-0001-update-fee-rule-fee-rule-name-fee-rule-name-is-required '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: Fee rule not found content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: mtch-0114-fee-rule-not-found: $ref: '#/components/examples/mtch-0114-fee-rule-not-found' '409': description: Conflict — duplicate priority or name content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: mtch-0107-a-fee-rule-with-this-priority-already-exists-in-the-context: $ref: >- #/components/examples/mtch-0107-a-fee-rule-with-this-priority-already-exists-in-the-context mtch-0101-a-fee-rule-with-this-name-already-exists-in-the-context: $ref: >- #/components/examples/mtch-0101-a-fee-rule-with-this-name-already-exists-in-the-context '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`, and an idempotency storage failure returns `500`. These refusals are problem documents. schema: type: string schemas: UpdateFeeRuleRequest: additionalProperties: false properties: feeScheduleId: description: >- UUID of the fee schedule this rule applies when its predicates match. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string name: description: Human-readable name of the fee rule. examples: - Updated Rule type: string predicates: description: >- Predicates (ANDed together) that a transaction's metadata must satisfy for this rule to apply. Replaces the existing predicate set when provided. items: $ref: '#/components/schemas/FieldPredicateRequest' type: array priority: description: >- Evaluation priority; lower numbers are evaluated first. Must remain unique within the context. LEFT, RIGHT, and ANY rules share the same priority space. examples: - 1 format: int64 type: integer side: description: >- Side the rule applies to. LEFT and RIGHT target one reconciliation side; ANY matches transactions on either side. enum: - LEFT - RIGHT - ANY examples: - LEFT type: string type: object FeeRuleResponse: additionalProperties: false properties: contextId: description: Identifier of the context the rule belongs to. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string createdAt: description: Creation timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string feeScheduleId: description: Identifier of the fee schedule this rule applies. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string id: description: Unique identifier of the fee rule. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string name: description: Human-readable name of the fee rule. examples: - BB Right-Side Rule type: string predicates: description: >- Predicates (ANDed together) that a transaction's metadata must satisfy for this rule to apply. items: $ref: '#/components/schemas/FieldPredicateResponse' type: - array - 'null' priority: description: Evaluation priority; lower numbers are evaluated first. examples: - 0 format: int64 type: integer side: description: >- Side the rule applies to. LEFT and RIGHT target one reconciliation side; ANY matches transactions on either side. enum: - LEFT - RIGHT - ANY examples: - RIGHT type: string updatedAt: description: Last update timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string required: - id - contextId - side - feeScheduleId - name - priority - predicates - createdAt - updatedAt 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 FieldPredicateRequest: additionalProperties: false properties: field: description: Transaction metadata field the predicate tests. examples: - institution type: string operator: description: >- Comparison operator. EQUALS matches a single value; NEQ is its negation (numeric when both sides parse as decimals, else case-insensitive string). IN matches any value in the values list. EXISTS asserts the field is present (no value needed). GT/GTE/LT/LTE compare the field numerically against a single decimal value. BETWEEN tests inclusive numeric membership in values=[lo, hi] (lo<=hi). enum: - EQUALS - IN - EXISTS - GT - GTE - LT - LTE - BETWEEN - NEQ examples: - EQUALS type: string value: description: Comparison value, required for the EQUALS operator. examples: - Banco do Brasil type: string values: description: Candidate values, required for the IN operator. items: type: string type: - array - 'null' required: - field - operator type: object FieldPredicateResponse: additionalProperties: false properties: field: description: Transaction metadata field the predicate tests. examples: - institution type: string operator: description: >- Comparison operator. EQUALS matches a single value; NEQ is its negation (numeric when both sides parse as decimals, else case-insensitive string). IN matches any value in the values list. EXISTS asserts the field is present. GT/GTE/LT/LTE compare the field numerically against a single decimal value. BETWEEN tests inclusive numeric membership in values=[lo, hi] (lo<=hi). enum: - EQUALS - IN - EXISTS - GT - GTE - LT - LTE - BETWEEN - NEQ examples: - EQUALS type: string value: description: Comparison value used by the EQUALS operator. examples: - Banco do Brasil type: string values: description: Candidate values used by the IN operator. items: type: string type: - array - 'null' required: - field - operator 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 ErrorResponse: description: >- Flat error body that Matcher returns when it refuses a request before the operation runs. type: object required: - code - title - message properties: code: type: string description: Stable error code. example: MTCH-0003 title: type: string description: HTTP status text. example: Unauthorized message: type: string description: Human-readable error message. example: missing authorization token 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: mtch-0001-update-fee-rule-fee-rule-name-fee-rule-name-is-required: summary: 'Update fee rule: fee rule name: fee rule name is required' value: type: https://errors.lerian.studio/v1/MTCH-0001 title: Bad Request status: 400 detail: a fee rule name is required; provide a name and try again code: MTCH-0001 mtch-0114-fee-rule-not-found: summary: Fee rule not found value: type: https://errors.lerian.studio/v1/MTCH-0114 title: Not Found status: 404 detail: The fee rule could not be found; check the fee rule id and try again code: MTCH-0114 mtch-0107-a-fee-rule-with-this-priority-already-exists-in-the-context: summary: A fee rule with this priority already exists in the context value: type: https://errors.lerian.studio/v1/MTCH-0107 title: Conflict status: 409 detail: >- A fee rule with this priority already exists in this context; choose a different priority and try again code: MTCH-0107 mtch-0101-a-fee-rule-with-this-name-already-exists-in-the-context: summary: A fee rule with this name already exists in the context value: type: https://errors.lerian.studio/v1/MTCH-0101 title: Conflict status: 409 detail: >- A fee rule with this name already exists in this context; choose a different name. code: MTCH-0101 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/MTCH-0003 title: Unauthorized status: 401 detail: missing authorization token code: MTCH-0003 InvalidToken: summary: Invalid token value: type: https://errors.lerian.studio/v1/MTCH-0003 title: Unauthorized status: 401 detail: invalid authorization token code: MTCH-0003 application/json: schema: $ref: '#/components/schemas/ErrorResponse' text/plain: schema: type: string example: Unauthorized Forbidden: description: You do not have permission to access this resource. content: text/plain: schema: type: string example: Forbidden application/json: schema: $ref: '#/components/schemas/ErrorResponse' 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 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.