Pular para o conteúdo principal
POST
Simular cálculo de tarifa

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.

Parâmetros de caminho

scheduleId
string
obrigatório

The unique identifier of the fee schedule.

Corpo

application/json

Payload de simulação de tarifa

Payload para simular o cálculo de tarifas em uma tabela de tarifas

grossAmount
string
obrigatório

Valor bruto da transação sobre o qual simular as tarifas

Exemplo:

"100.00"

currency
string
obrigatório

Código de moeda (ISO 4217)

Exemplo:

"USD"

Resposta

Resultado da simulação de tarifa.

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.

Resultado de uma simulação de tarifa

grossAmount
string

Valor bruto original

Exemplo:

"100.00"

netAmount
string

Valor após a dedução das tarifas

Exemplo:

"97.70"

totalFee
string

Valor total das tarifas

Exemplo:

"2.30"

currency
string

Código de moeda (ISO 4217)

Exemplo:

"USD"

items
object[]

Detalhamento dos itens de tarifa individuais

Maximum array length: 100