Create a fee rule

Use this endpoint to create a new fee rule that maps transaction metadata to a fee schedule within a context.

Priority must be unique within a context across all sides (LEFT, RIGHT, and ANY rules share the same priority space). The caller must also be allowed to read the referenced fee schedule.

POST /v1/contexts/{contextId}/fee-rules

Create a fee rule

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/fee-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feeScheduleId": "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"
}
'

201

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.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

Cuerpo

application/json

Fee rule creation payload

feeScheduleId · string · requerido

UUID of the fee schedule this rule applies when its predicates match.

Ejemplo:

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

name · string · requerido

Human-readable name of the fee rule.

Required string length: 1 - 100

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. Must be unique within the context. LEFT, RIGHT, and ANY rules share the same priority space.

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"

Respuesta

201

application/json

Successfully created 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"