Pular para o conteúdo principal
POST
Criar uma tabela de tarifas

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

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.

Corpo

application/json

Payload de criação da tabela de tarifas

Payload para criação de uma tabela de tarifas

name
string
obrigatório

Nome de exibição da tabela de tarifas

Required string length: 1 - 100
Exemplo:

"Card Processing - Visa"

currency
string
obrigatório

Código de moeda (ISO 4217)

Maximum string length: 3
Exemplo:

"USD"

applicationOrder
enum<string>
obrigatório

Como múltiplos itens de tarifa se compõem

Opções disponíveis:
PARALLEL,
CASCADING
Exemplo:

"PARALLEL"

items
object[]
obrigatório

Itens de tarifa a incluir nesta tabela

Required array length: 1 - 100 elements
roundingScale
integer

Número de casas decimais para arredondamento

Exemplo:

2

roundingMode
enum<string>

Método de arredondamento para cálculos intermediários

Opções disponíveis:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Exemplo:

"HALF_UP"

Resposta

Tabela de tarifas 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 reprodução de uma requisição processada anteriormente.

Consulte Retentativas e idempotência para mais detalhes.

Tabela de tarifas com seus itens de tarifa

id
string<uuid>

Identificador único da tabela de tarifas

Exemplo:

"019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b"

tenantId
string<uuid>

Tenant proprietário desta tabela de tarifas

Exemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

name
string

Nome de exibição da tabela de tarifas

Maximum string length: 100
Exemplo:

"Card Processing - Visa"

currency
string

Código de moeda (ISO 4217)

Exemplo:

"USD"

applicationOrder
enum<string>

Como múltiplos itens de tarifa se compõem

Opções disponíveis:
PARALLEL,
CASCADING
Exemplo:

"PARALLEL"

roundingScale
integer

Número de casas decimais para arredondamento

Exemplo:

2

roundingMode
enum<string>

Método de arredondamento para cálculos intermediários

Opções disponíveis:
HALF_UP,
BANKERS,
FLOOR,
CEIL,
TRUNCATE
Exemplo:

"HALF_UP"

items
object[]

Itens de tarifa nesta tabela

Maximum array length: 100
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"