Pular para o conteúdo principal
POST
/
v1
/
contexts
/
{contextId}
/
fee-rules
Criar uma regra de tarifa
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>"
      ]
    }
  ]
}
'
{
  "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"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Cabeçalhos

​
X-Request-Id
string

Um identificador único para rastrear a requisição entre os serviços.

​
X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

​
contextId
string<uuid>
obrigatório

O identificador único do contexto de conciliação.

Corpo

application/json

Payload de criação de regra de tarifa

Payload da requisição para criação de uma regra de tarifa

​
feeScheduleId
string
obrigatório

A tabela de tarifas a aplicar quando esta regra encontrar correspondência

Exemplo:

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

​
name
string
obrigatório

Nome de exibição da regra de tarifa

Required string length: 1 - 100
Exemplo:

"BB Right-Side Rule"

​
side
enum<string>
obrigatório

Lado da transação ao qual esta regra se aplica

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

"RIGHT"

​
priority
integer

Prioridade de avaliação (deve ser única dentro do contexto; regras LEFT, RIGHT e ANY compartilham o mesmo espaço de prioridade)

Intervalo obrigatório: x >= 0
Exemplo:

0

​
predicates
object[]

Condições que devem ser todas atendidas para que esta regra seja aplicada

Maximum array length: 50

Resposta

Regra de tarifa criada com sucesso.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retries and idempotency para mais detalhes.

Uma regra de tarifa que mapeia metadados de transação para uma tabela de tarifas dentro de um contexto de conciliação

​
id
string<uuid>

Identificador único da regra de tarifa

Exemplo:

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

​
contextId
string<uuid>

Contexto de conciliação ao qual esta regra pertence

Exemplo:

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

​
feeScheduleId
string<uuid>

Tabela de tarifas aplicada quando esta regra encontra correspondência

Exemplo:

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

​
name
string

Nome de exibição da regra de tarifa

Exemplo:

"BB Right-Side Rule"

​
side
enum<string>

Lado da transação ao qual esta regra se aplica

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

"RIGHT"

​
priority
integer

Prioridade de avaliação (números menores são avaliados primeiro; regras LEFT, RIGHT e ANY compartilham o mesmo espaço de prioridade)

Exemplo:

0

​
predicates
object[]

Condições que devem ser todas atendidas para que esta regra seja aplicada

​
createdAt
string<date-time>

Timestamp de criação no formato RFC 3339

Exemplo:

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

​
updatedAt
string<date-time>

Timestamp da última atualização no formato RFC 3339

Exemplo:

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