Skip to main content
GET
Get a fee rule

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

Parâmetros de caminho

feeRuleId
string<uuid>
obrigatório

The unique identifier of the fee rule.

Resposta

Successfully retrieved fee rule

A fee rule that maps transaction metadata to a fee schedule within a reconciliation context

id
string<uuid>

Unique identifier for the fee rule

Exemplo:

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

contextId
string<uuid>

Reconciliation context this rule belongs to

Exemplo:

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

feeScheduleId
string<uuid>

Fee schedule applied when this rule matches

Exemplo:

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

name
string

Display name for the fee rule

Exemplo:

"BB Right-Side Rule"

side
enum<string>

Which transaction side this rule applies to

Opções disponíveis:
LEFT,
RIGHT,
ANY
Exemplo:

"RIGHT"

priority
integer

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

Exemplo:

0

predicates
object[]

Conditions that must all match for this rule to apply

createdAt
string<date-time>

Creation timestamp in RFC 3339 format

Exemplo:

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

updatedAt
string<date-time>

Last update timestamp in RFC 3339 format

Exemplo:

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