v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Fee Schedules

Get a fee schedule

Use this endpoint to retrieve the details of a specific fee schedule by its identifier.

get/v1/fee-schedules/{scheduleId}

Path parameters

scheduleIdstring required

The unique identifier of the fee schedule.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Successfully retrieved fee schedule

idstring uuid

Unique identifier for the fee schedule

tenantIdstring uuid

Tenant that owns this fee schedule

namestring

Display name for the fee schedule

currencystring

Currency code (ISO 4217)

applicationOrder'PARALLEL' | 'CASCADING'

Determines how multiple fee items compose within a schedule

roundingScaleinteger

Number of decimal places for rounding

roundingMode'HALF_UP' | 'BANKERS' | 'FLOOR' | 'CEIL' | 'TRUNCATE'

Determines how intermediate fee calculations are rounded

createdAtstring date-time

Creation timestamp in RFC 3339 format

updatedAtstring date-time

Last update timestamp in RFC 3339 format

Example response

{
  "id": "019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b",
  "tenantId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "name": "Card Processing - Visa",
  "currency": "USD",
  "roundingScale": 2,
  "items": [
    {
      "id": "019c96a0-2b20-7123-9a1b-2c3d4e5f6a7b",
      "name": "interchange",
      "priority": 1,
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z"
}