v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Fee Rules

Get a fee rule

Use this endpoint to retrieve the details of a specific fee rule by its identifier.

get/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.

Response

Successfully retrieved fee rule

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"
}