v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Benchmark rate

Configure benchmark rate

Configure the benchmark rate and its start date. Used to calculate interest accual for floating and hybrid investments.

post/v1/interest/benchmark-rate

Headers

content-typestring required

Content type

Authorizationstring required

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a "** 401 Unauthorized**" error.

Request body

benchmark'BOE' | 'DI' | 'FED' | 'RBA' | 'RBI' | 'TO' required

Market index used to measure interest value over time.

BOE: Bank of England, UK
DI: Interbank Deposit Contract, Brazil
FED: Federal Reserve System, USA
RBA: Reserve Bank of Australia
RBI: Reserve Bank of India
TO: Overnight Interbank Target Rate (Tasa Objetivo), Mexico

benchmark_ratenumber double required

Annual market index rate

start_datestring date required

Date to start applying the benchmark rate in the accrual process. Format = YYYY-MM-DD.

Example request

{
  "benchmark": "FED",
  "benchmark_rate": 0.104,
  "start_date": "2024-09-04"
}

Response

benchmark_ratenumber double

Annual market index rate

start_datestring date

Date to start applying the benchmark rate in the accrual process. Format = YYYY-MM-DD.

versionstring

Benchmark rate version. Format = YYYY-MM.

division_idstring

Division ID attached to the interest plan for accrual by division

Example response

{
  "benchmark_rate": 0.104,
  "start_date": "2024-09-10",
  "version": "2024-09",
  "division_id": "d9b2c9e1-4633-4a10-841b-270f7f1493cd",
  "interest_by_tiers": {
    "type": "TERM",
    "tier_calculation": "RETROACTIVE",
    "tiers": [
      {
        "days": 30,
        "amount": 1000,
        "margin_rate": 1,
        "fixed_interest_rate": 1.2
      },
      {
        "days": 60,
        "amount": 2000,
        "margin_rate": 1,
        "fixed_interest_rate": 1.3
      }
    ]
  },
  "interest_thresholds": {
    "cap_threshold": 1.1,
    "cap_effective_rate": 1.2,
    "floor_threshold": 2.2,
    "floor_effective_rate": 2.1
  }
}