# Get Org benchmark rates

Get all benchmark rates configured for an organization.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Banking - Interest engine",
    "version": "1.0.0",
    "description": "API to handle interest-bearing account operations",
    "termsOfService": "https://developers.pismo.io/terms/",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismolabs.io/pismo-docs/docs/support"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/interest-engine",
      "description": "Sandbox API server for testing"
    },
    {
      "url": "https://sandbox.pismolabs.io/passport/v2/s2s/access-token",
      "description": "Sandbox API for oauth2"
    }
  ],
  "tags": [
    {
      "name": "Benchmark rate",
      "description": "Manage benchmarks"
    }
  ],
  "components": {
    "parameters": {
      "Authorization": {
        "name": "authorization",
        "in": "header",
        "description": "Authorization",
        "required": true,
        "example": "Bearer YOUR_BEARER_TOKEN",
        "schema": {
          "type": "string"
        }
      },
      "ContentType": {
        "name": "content-type",
        "in": "header",
        "description": "Content type",
        "required": true,
        "example": "application/json",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "Amount": {
        "type": "number",
        "format": "double",
        "description": "Amount in the `interest_by_tier`",
        "example": 1000
      },
      "BenchmarkRequired": {
        "type": "string",
        "description": "Market index used to measure interest value over time.\n  - `BOE`: Bank of England, UK\n  - `DI`: Interbank Deposit Contract, Brazil\n  - `FED`: Federal Reserve System, USA\n  - `RBA`: Reserve Bank of Australia\n  - `RBI`: Reserve Bank of India\n  - `TO`: Overnight Interbank Target Rate (Tasa Objetivo), Mexico\n",
        "enum": [
          "BOE",
          "DI",
          "FED",
          "RBA",
          "RBI",
          "TO"
        ],
        "example": "FED"
      },
      "BenchmarkRate": {
        "type": "number",
        "format": "double",
        "description": "Annual market index rate",
        "example": 0.104
      },
      "BenchmarkRateList": {
        "type": "array",
        "format": "array",
        "items": {
          "$ref": "#/components/schemas/GetBenchmarkRate"
        },
        "description": "Benchmark rate list"
      },
      "CapEffectiveRate": {
        "type": "number",
        "format": "double",
        "description": "Cap effective rate. If you provide a value for `cap_effective_rate`, you must also provide a value for `cap_threshold`.",
        "example": 1.2
      },
      "CapThreshold": {
        "type": "number",
        "format": "double",
        "description": "Cap threshold value. If you provide a value for `cap_threshold`, you must also provide a value for `cap_effective_rate`.",
        "example": 1.1
      },
      "Days": {
        "type": "integer",
        "format": "int32",
        "description": "Number of days in `interest_by_tier`",
        "example": 30
      },
      "DivisionId": {
        "type": "string",
        "description": "Division ID attached to the interest plan for accrual by division",
        "example": "d9b2c9e1-4633-4a10-841b-270f7f1493cd"
      },
      "FixedInterestRate": {
        "type": "number",
        "format": "float",
        "description": "Fixed annual interest rate for investments or deposits. If a `benchmark` value is provided, this field must be null.",
        "example": 0.1
      },
      "FloorEffectiveRate": {
        "type": "number",
        "format": "double",
        "description": "Floor effective rate",
        "example": 2.2
      },
      "FloorThreshold": {
        "type": "number",
        "format": "double",
        "description": "Floor threshold value",
        "example": 2.1
      },
      "GetBenchmarkRate": {
        "type": "object",
        "properties": {
          "benchmark": {
            "$ref": "#/components/schemas/BenchmarkRequired"
          },
          "benchmark_rate": {
            "$ref": "#/components/schemas/BenchmarkRate"
          },
          "start_date": {
            "$ref": "#/components/schemas/StartDate"
          },
          "version": {
            "$ref": "#/components/schemas/Version"
          },
          "division_id": {
            "$ref": "#/components/schemas/DivisionId"
          },
          "interest_by_tiers": {
            "$ref": "#/components/schemas/InterestByTiers"
          },
          "interest_thresholds": {
            "$ref": "#/components/schemas/InterestThresholds"
          }
        }
      },
      "GetBenchmarkRateOrgResponse": {
        "title": "Get benchmark rate org response",
        "type": "object",
        "properties": {
          "get_benchmark_rate_org_list": {
            "$ref": "#/components/schemas/BenchmarkRateList"
          }
        }
      },
      "InterestByTiers": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/InterestByTiersType"
          },
          "tier_calculation": {
            "$ref": "#/components/schemas/TierCalculation"
          },
          "tiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InterestByTiersArrayObject"
            }
          }
        },
        "required": [
          "type",
          "tier_calculation",
          "tiers"
        ],
        "description": "Interest by tiers configuration",
        "example": {
          "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
            }
          ]
        }
      },
      "InterestByTiersArrayObject": {
        "type": "object",
        "properties": {
          "days": {
            "$ref": "#/components/schemas/Days"
          },
          "amount": {
            "$ref": "#/components/schemas/Amount"
          },
          "margin_rate": {
            "$ref": "#/components/schemas/MarginRate"
          },
          "fixed_interest_rate": {
            "$ref": "#/components/schemas/FixedInterestRate"
          }
        },
        "description": "Tier details for interest calculation"
      },
      "InterestByTiersType": {
        "type": "string",
        "description": "Interest type\n- `TERM`: Interest rate varies according to the period of time since the deposit was made.\n- `AMOUNT`: Interest rate varies according to the current balance.\n",
        "enum": [
          "TERM",
          "AMOUNT"
        ],
        "example": "TERM"
      },
      "InterestThresholds": {
        "type": "object",
        "properties": {
          "cap_threshold": {
            "$ref": "#/components/schemas/CapThreshold"
          },
          "cap_effective_rate": {
            "$ref": "#/components/schemas/CapEffectiveRate"
          },
          "floor_threshold": {
            "$ref": "#/components/schemas/FloorThreshold"
          },
          "floor_effective_rate": {
            "$ref": "#/components/schemas/FloorEffectiveRate"
          }
        },
        "description": "Cap and floor thresholds for the interest plan",
        "example": {
          "interest_thresholds": {
            "cap_threshold": 1.1,
            "cap_effective_rate": 1.2,
            "floor_threshold": 2.2,
            "floor_effective_rate": 2.1
          }
        }
      },
      "MarginRate": {
        "type": "number",
        "format": "double",
        "description": "Rate linked to the benchmark rate. For example, for 110% FED, margin rate is 110%. If a `benchmark` value is not provided, this field must be null.",
        "example": 1.1
      },
      "StartDate": {
        "type": "string",
        "format": "date",
        "description": "Date to start applying the benchmark rate in the accrual process. Format = YYYY-MM-DD.",
        "example": "2024-09-10"
      },
      "TierCalculation": {
        "type": "string",
        "description": "Tier calculation method\n- `RETROACTIVE`: Interest is recalculated from the beginning based on the new applicable rate.\n- `NON-RETROACTIVE`: Interest is calculated progressively based on each layer rate.\n",
        "enum": [
          "RETROACTIVE",
          "NON-RETROACTIVE"
        ],
        "example": "RETROACTIVE"
      },
      "Version": {
        "type": "string",
        "description": "Benchmark rate version. Format = YYYY-MM.",
        "example": "2024-09"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad request"
      },
      "401Unauthorized": {
        "description": "Unauthorized"
      },
      "404NotFound": {
        "description": "Not found"
      },
      "500InternalServerError": {
        "description": "Internal server error"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/interest/benchmark-rate": {
      "get": {
        "summary": "Get Org benchmark rates",
        "description": "Get all benchmark rates configured for an organization.",
        "tags": [
          "Benchmark rate"
        ],
        "operationId": "get-v1-benchmark-rate-org",
        "parameters": [
          {
            "$ref": "#/components/parameters/ContentType"
          },
          {
            "$ref": "#/components/parameters/Authorization"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBenchmarkRateOrgResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```