v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration Fee Schedules

Update a fee schedule

Use this endpoint to update the fields of a specific fee schedule by its identifier.

patch/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.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

namestring

Updated display name

applicationOrder'PARALLEL' | 'CASCADING'

Determines how multiple fee items compose within a schedule

roundingScaleinteger

Updated number of decimal places

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

Determines how intermediate fee calculations are rounded

Example request

{
  "name": "Updated Schedule",
  "roundingScale": 4
}

Response

Successfully updated fee schedule.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

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"
}