Calculate fee

Calculate transaction fee. When `customer_id` is set, the server resolves `reference_id` from customer metadata (`{customer_id}:{package_year}`). Either `customer_id` or `reference_id` must be supplied. With `commit: true`, pass `transfer_id` so velocity commits are idempotent per transfer and matched rule (`transfer_id:rule_id`).

POST/v1/tariffs/calculate-fee

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Provide customer_id (server resolves reference_id) or an explicit reference_id. When commit is true, include transfer_id for per-transfer velocity idempotency. Omitted or empty from_channel / to_channel default to any (wildcard fee-range matching).

tariff_id?string

Optional. When omitted, the customer's assigned tariff is used.

customer_id?string

Optional. Resolves velocity reference_id from customer metadata when set; satisfies the reference requirement without sending reference_id.

amount*

Transaction amount in minor/atomic units with currency code

asset?string

Asset filter for fee range matching. If omitted or 'any', the currency from amount is used for fee denomination.

from_channel?string

Origin channel filter for fee range matching. Optional; omitted or empty values are treated as any.

to_channel?string

Destination channel filter for fee range matching. Optional; omitted or empty values are treated as any.

media*string

transaction_type?string

Transaction type (e.g., iwt, owt, int, own, crw, or 'any' for all types). Must be a valid product code of type 'transfers' or 'any'.

reference_id?string

Velocity bucket key. Required when customer_id is omitted; ignored/overwritten when customer_id is set and enrichment runs.

transfer_id?string

Optional. When commit is true, scopes velocity commit idempotency per transfer and matched rule (transfer_id:rule_id).

value_date?string

Optional future date for tariff calculation. If not provided, current date is used.

commit?boolean

When true, records velocity usage for matched rules.

fee_ccy?string

When set, return all fees (fixed_fee, total_fee, min_fee, max_fee) in this currency using FX mid rate. On rate failure, falls back to system base currency.

Response Body

`application/json`

curl -X POST "https://example.com/v1/tariffs/calculate-fee" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "amount": "string",      "currency": "string"    },    "media": "string"  }'

{
  "tariff_id": "d82b8db6-f412-4b9c-8c5e-6a0221035c86",
  "tariff_name": "string",
  "fee_range_id": "e83fe3ea-57cf-4b81-97b5-d4ebfa07c6cf",
  "fixed_fee": {
    "amount": "string",
    "currency": "string",
    "precision": 0
  },
  "percent_fee": 0,
  "total_fee": {
    "amount": "string",
    "currency": "string",
    "precision": 0
  },
  "min_fee": {
    "amount": "string",
    "currency": "string",
    "precision": 0
  },
  "max_fee": {
    "amount": "string",
    "currency": "string",
    "precision": 0
  },
  "method": "fixed",
  "is_fallback": true
}

Authorization

Request Body

Response Body

200application/json

`application/json`