Skip to main content
POST
Create 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.

​
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, and an idempotency storage failure returns 500. These refusals are problem documents.

Path Parameters

​
contextId
string<uuid>
required

The unique identifier of the reconciliation context. Context ID

Body

application/json

Fee rule creation payload

​
feeScheduleId
string
required

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

Example:

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

​
name
string
required

Human-readable name of the fee rule.

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

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"

Response

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