Get a fee rule

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

GET /v1/fee-rules/{feeRuleId}

Get a fee rule

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/fee-rules/{feeRuleId} \
  --header 'Authorization: Bearer <token>'

200

Example

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

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

feeRuleId · string<uuid> · requerido

The unique identifier of the fee rule. Fee Rule ID

Respuesta

200

application/json

Successfully retrieved fee rule

contextId · string · requerido

Identifier of the context the rule belongs to.

Ejemplo:

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

createdAt · string · requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

feeScheduleId · string · requerido

Identifier of the fee schedule this rule applies.

Ejemplo:

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

id · string · requerido

Unique identifier of the fee rule.

Ejemplo:

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

name · string · requerido

Human-readable name of the fee rule.

Ejemplo:

"BB Right-Side Rule"

predicates · object[] | null · requerido

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

Show child attributes

priority · integer<int64> · requerido

Evaluation priority; lower numbers are evaluated first.

Ejemplo:

0

side · enum<string> · requerido

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

Opciones disponibles: LEFT, RIGHT, ANY

Ejemplo:

"RIGHT"

updatedAt · string · requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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