Skip to main content
GET
Get a fee rule

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.

Path Parameters

feeRuleId
string<uuid>
required

The unique identifier of the fee rule. Fee Rule ID

Response

Successfully retrieved fee rule

contextId
string
required

Identifier of the context the rule belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

feeScheduleId
string
required

Identifier of the fee schedule this rule applies.

Example:

"550e8400-e29b-41d4-a716-446655440000"

id
string
required

Unique identifier of the fee rule.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

Human-readable name of the fee rule.

Example:

"BB Right-Side Rule"

predicates
object[] | null
required

Predicates (ANDed together) that a transaction's metadata must satisfy for this rule to apply.

priority
integer<int64>
required

Evaluation priority; lower numbers are evaluated first.

Example:

0

side
enum<string>
required

Side the rule applies to. LEFT and RIGHT target one reconciliation side; ANY matches transactions on either side.

Available options:
LEFT,
RIGHT,
ANY
Example:

"RIGHT"

updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"