Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Configuration Fee Rules

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.

patch/v1/fee-rules/{feeRuleId}

Path parameters

feeRuleIdstring uuid required

The unique identifier of the fee rule.

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

feeScheduleIdstring

Updated fee schedule to apply when this rule matches

namestring

Updated display name for the fee rule

side'LEFT' | 'RIGHT' | 'ANY'

Updated transaction side

priorityinteger

Updated evaluation priority (must remain unique within the context)

Example request

{
  "name": "Updated Rule",
  "side": "LEFT",
  "predicates": [
    {
      "field": "institution",
      "operator": "EQUALS",
      "value": "Banco do Brasil"
    }
  ]
}

Response

Successfully updated fee rule.

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.

idstring uuid

Unique identifier for the fee rule

contextIdstring uuid

Reconciliation context this rule belongs to

feeScheduleIdstring uuid

Fee schedule applied when this rule matches

namestring

Display name for the fee rule

side'LEFT' | 'RIGHT' | 'ANY'

Which transaction side this rule applies to

priorityinteger

Evaluation priority (lower numbers are evaluated first; LEFT, RIGHT, and ANY rules share the same priority space)

createdAtstring date-time

Creation timestamp in RFC 3339 format

updatedAtstring date-time

Last update timestamp in RFC 3339 format

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "feeScheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "BB Right-Side Rule",
  "side": "RIGHT",
  "predicates": [
    {
      "field": "institution",
      "operator": "EQUALS",
      "value": "Banco do Brasil"
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}