---
updatedAt: 2026-06-17T17:50:44.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# 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"
        }
      },
      "XTenant": {
        "name": "x-tenant",
        "in": "header",
        "description": "Organization ID",
        "required": true,
        "example": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
        "schema": {
          "type": "string"
        }
      },
      "XCid": {
        "name": "x-cid",
        "in": "header",
        "description": "Optional correlation ID used to trace the request across services. When omitted, one is generated automatically.",
        "required": false,
        "example": "b3f1c2d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "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"
      },
      "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"
          }
        }
      },
      "GetBenchmarkRateOrgResponse": {
        "title": "Get benchmark rate org response",
        "type": "object",
        "properties": {
          "get_benchmark_rate_org_list": {
            "$ref": "#/components/schemas/BenchmarkRateList"
          }
        }
      },
      "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"
      },
      "Version": {
        "type": "string",
        "description": "Benchmark rate version. Format = YYYY-MM.",
        "example": "2024-09"
      },
      "ErrorResponse": {
        "type": "object",
        "description": "Standard error payload generated by the global exception handler.\n`message` is a single string for most errors and an array of strings\nwhen multiple bean-validation or request-binding errors occur in the same request.\n",
        "additionalProperties": false,
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        },
        "example": {
          "message": "interest account not found"
        }
      },
      "ErrorResponseDeserialization": {
        "type": "object",
        "description": "Error payload generated only when the request body fails JSON deserialization\n(unknown field or invalid JSON structure). Returned with HTTP 400.\n",
        "additionalProperties": false,
        "required": [
          "error",
          "status"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Short error category."
          },
          "message": {
            "type": "string",
            "description": "Details about the field or structure that causes the error."
          },
          "field": {
            "type": "string",
            "description": "Name of the invalid field. Present only for unknown-field errors."
          },
          "status": {
            "type": "integer",
            "description": "HTTP status code, always 400 for this shape."
          }
        },
        "example": {
          "error": "Invalid field in request",
          "message": "Field 'foo' is not allowed. Only the following fields can be updated: start_date, description, fixed_interest_rate, margin_rate, margin, interest_by_tiers, interest_thresholds",
          "field": "foo",
          "status": 400
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "anyOf": [
                {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                {
                  "$ref": "#/components/schemas/ErrorResponseDeserialization"
                }
              ]
            },
            "examples": {
              "validation": {
                "summary": "Bean validation or binding errors",
                "value": {
                  "message": [
                    "fixed_interest_rate must be informed",
                    "margin_rate must be positive"
                  ]
                }
              },
              "requestBody": {
                "summary": "invalid or missing request value",
                "value": {
                  "message": "Failed to process your request. Validate the fields in your request."
                }
              },
              "tenantHeader": {
                "summary": "Tenant header missing or malformed",
                "value": {
                  "message": "x-tenant header is missing or malformed"
                }
              },
              "unknownField": {
                "summary": "Unknown field in request body",
                "value": {
                  "error": "Invalid field in request",
                  "message": "Field 'foo' is not allowed. Only the following fields can be updated: start_date, description, fixed_interest_rate, margin_rate, margin, interest_by_tiers, interest_thresholds",
                  "field": "foo",
                  "status": 400
                }
              },
              "invalidJson": {
                "summary": "Invalid JSON body",
                "value": {
                  "error": "Invalid JSON format",
                  "message": "Request contains invalid JSON structure or field types",
                  "status": 400
                }
              },
              "taxWithholdingAccrualFeeRequired": {
                "summary": "ACCRUAL withholding without fee_processing_code",
                "value": {
                  "message": [
                    "fee_processing_code is required when tax_withholding.withholding_moment is ACCRUAL."
                  ]
                }
              },
              "taxWithholdingAccrualTaxRulesNotAllowed": {
                "summary": "ACCRUAL withholding with tax_rules present",
                "value": {
                  "message": [
                    "tax_rules must be null when tax_withholding.withholding_moment is ACCRUAL."
                  ]
                }
              },
              "taxWithholdingCapitalizationFeeNotAllowed": {
                "summary": "CAPITALIZATION withholding with fee_processing_code present",
                "value": {
                  "message": [
                    "fee_processing_code must be null when tax_withholding.withholding_moment is CAPITALIZATION."
                  ]
                }
              },
              "taxWithholdingCapitalizationTaxRulesRequired": {
                "summary": "CAPITALIZATION withholding without tax_rules",
                "value": {
                  "message": [
                    "tax_rules is required when tax_withholding.withholding_moment is CAPITALIZATION."
                  ]
                }
              },
              "taxWithholdingNoneFieldsNotAllowed": {
                "summary": "NULL withholding_moment with fee_processing_code or tax_rules present",
                "value": {
                  "message": [
                    "fee_processing_code and tax_rules must be null when tax_withholding.withholding_moment is NULL."
                  ]
                }
              },
              "taxWithholdingNotAllowedWhenTaxesExemption": {
                "summary": "taxes_exemption is true with tax_withholding present",
                "value": {
                  "message": [
                    "tax_withholding must be null when taxes_exemption is true."
                  ]
                }
              }
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Unauthorized. The response body is produced by the upstream authentication gateway and is not defined by this service."
      },
      "404NotFound": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "interestAccountNotFound": {
                "summary": "Interest account not found",
                "value": {
                  "message": "interest account not found"
                }
              },
              "interestPlanNotFound": {
                "summary": "Interest plan not found",
                "value": {
                  "message": "interest plan not found"
                }
              },
              "benchmarkNotFound": {
                "summary": "Benchmark not found",
                "value": {
                  "message": "benchmark not found"
                }
              }
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "message": "Failed to process your request"
            }
          }
        }
      }
    }
  },
  "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/XTenant"
          },
          {
            "$ref": "#/components/parameters/XCid"
          },
          {
            "$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"
          }
        }
      }
    }
  }
}
```