Crear una regla de tarifa

Utilice este endpoint para crear una nueva regla de tarifa que asocie metadatos de transacciones con una tabla de tarifas dentro de un contexto.

La prioridad debe ser única dentro del contexto para todos los lados (las reglas LEFT, RIGHT y ANY comparten el mismo espacio de prioridades). El solicitante también debe tener permiso de lectura sobre la tabla de tarifas referenciada.

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

Crear una regla de tarifa

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",
  "side": "RIGHT",
  "priority": 0,
  "predicates": [
    {
      "field": "institution",
      "operator": "EQUALS",
      "value": "Banco do Brasil",
      "values": [
        "<string>"
      ]
    }
  ]
}
'

201

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

Autorizaciones

Authorization · string · header · requerido

Autenticación con token Bearer (formato: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

X-Idempotency-Key · string

Clave de idempotencia opcional para reintentos seguros. También acepta Idempotency-Key como nombre de encabezado alternativo. Si se envía la misma clave nuevamente y la solicitud original ya fue procesada, se devuelve la respuesta en caché con X-Idempotency-Replayed: true.

Consulte Reintentos e idempotencia para más detalles.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context.

Cuerpo

application/json

Payload de creación de regla de tarifa

Payload de solicitud para crear una regla de tarifa

feeScheduleId · string · requerido

La tabla de tarifas que se aplicará cuando esta regla produzca una coincidencia

Ejemplo:

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

name · string · requerido

Nombre de visualización de la regla de tarifa

Required string length: 1 - 100

Ejemplo:

"BB Right-Side Rule"

side · enum<string> · requerido

Lado de la transacción al que se aplica esta regla

Opciones disponibles: LEFT, RIGHT, ANY

Ejemplo:

"RIGHT"

priority · integer · requerido

Prioridad de evaluación (debe ser única dentro del contexto; las reglas LEFT, RIGHT y ANY comparten el mismo espacio de prioridad)

Rango requerido: x >= 0

Ejemplo:

0

predicates · object[] · requerido

Condiciones que deben cumplirse todas para que se aplique esta regla

Maximum array length: 50

Show child attributes

Respuesta

201

application/json

Regla de tarifa creada correctamente.

La respuesta incluye el encabezado X-Idempotency-Replayed.

Si el valor es false, la solicitud acaba de ser procesada. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.

Consulte Reintentos e idempotencia para más detalles.

Una regla de tarifa que asocia metadatos de transacción con una tabla de tarifas dentro de un contexto de conciliación

id · string<uuid>

Identificador único de la regla de tarifa

Ejemplo:

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

contextId · string<uuid>

Contexto de conciliación al que pertenece esta regla

Ejemplo:

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

feeScheduleId · string<uuid>

Tabla de tarifas aplicada cuando esta regla produce una coincidencia

Ejemplo:

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

name · string

Nombre de visualización de la regla de tarifa

Ejemplo:

"BB Right-Side Rule"

side · enum<string>

Lado de la transacción al que se aplica esta regla

Opciones disponibles: LEFT, RIGHT, ANY

Ejemplo:

"RIGHT"

priority · integer

Prioridad de evaluación (los números más bajos se evalúan primero; las reglas LEFT, RIGHT y ANY comparten el mismo espacio de prioridad)

Ejemplo:

0

predicates · object[]

Condiciones que deben cumplirse todas para que se aplique esta regla

Show child attributes

createdAt · string<date-time>

Marca de tiempo de creación en formato RFC 3339

Ejemplo:

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

updatedAt · string<date-time>

Marca de tiempo de la última actualización en formato RFC 3339

Ejemplo:

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