# Get interest plan

Get interest plan details. By default, returns the latest version of the interest plan.
You can optionally specify a `version_date` query parameter to retrieve the version that was active on a specific date.
If a `version_date` is provided, the endpoint returns the latest version with a start date less than or equal to the specified date.


# 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": "Interest engine",
      "description": "Manage interest plans"
    }
  ],
  "components": {
    "parameters": {
      "Authorization": {
        "name": "authorization",
        "in": "header",
        "description": "Authorization",
        "required": true,
        "example": "Bearer YOUR_BEARER_TOKEN",
        "schema": {
          "type": "string"
        }
      },
      "InterestPlanIdPath": {
        "name": "interestPlanId",
        "in": "path",
        "description": "Interest plan ID generated during the plan's creation. Must be an alphanumeric UUID with the alphabetical characters in lowercase.",
        "required": true,
        "example": "d9b2c9e1-4633-4a10-841b-270f7f1493cd",
        "schema": {
          "type": "string"
        }
      },
      "VersionDate": {
        "name": "version_date",
        "in": "query",
        "description": "Optional date to retrieve a specific version of the interest plan. If not provided, returns the latest version. Format = YYYY-MM-DD.",
        "required": false,
        "example": "2025-06-17",
        "schema": {
          "type": "string",
          "format": "date"
        }
      }
    },
    "schemas": {
      "AccrualBasis": {
        "type": "string",
        "description": "Method used to calculate interest accrual.\n  * `BD/252`: Calculates daily interest using a 252-day year and the actual number of business days in each time period.\n  * `ACTUAL/360`: Calculates daily interest using a 360-day year and the actual number of days in each time period.\n  * `ACTUAL/365`: Calculates daily interest using a 365-day year and the actual number of days in each time period.\n  * `ACTUAL/ACTUAL`: Calculates daily interest using the actual number of days in the year (which in the leap year is 366) and the actual number of days in each time period.\n",
        "enum": [
          "BD/252",
          "ACTUAL/360",
          "ACTUAL/365",
          "ACTUAL/ACTUAL"
        ],
        "example": "ACTUAL/365"
      },
      "AccrualFrequency": {
        "type": "string",
        "description": "Interest accrual frequency",
        "enum": [
          "DAILY",
          "MONTHLY",
          "QUARTERLY",
          "HALF_YEARLY",
          "YEARLY",
          "MATURITY"
        ],
        "example": "DAILY"
      },
      "Benchmark": {
        "type": "string",
        "description": "Market index used to measure interest value over time. For fixed interest, this field must be null.\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"
      },
      "CapitalizationFrequency": {
        "type": "string",
        "description": "Interest payout frequency",
        "enum": [
          "DAILY",
          "MONTHLY",
          "QUARTERLY",
          "HALF_YEARLY",
          "YEARLY",
          "MATURITY"
        ],
        "example": "DAILY"
      },
      "CurrencyCode": {
        "type": "string",
        "format": "number",
        "description": "Numeric currency code in ISO 4217 standard",
        "example": "986"
      },
      "Description": {
        "type": "string",
        "description": "Interest plan name",
        "example": "Banking plan"
      },
      "FeeProcessingCode": {
        "type": "string",
        "format": "number",
        "description": "Processing code configured in the [fee model](https://developers.pismo.io/pismo-docs/docs/fee-model) for charging a tax, penalty, or fee.",
        "example": "001100"
      },
      "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
      },
      "GetInterestPlanResponse": {
        "title": "Get interest plan response",
        "type": "object",
        "properties": {
          "interest_plan_id": {
            "$ref": "#/components/schemas/InterestPlanId"
          },
          "org_id": {
            "$ref": "#/components/schemas/OrgId"
          },
          "description": {
            "$ref": "#/components/schemas/Description"
          },
          "currency_code": {
            "$ref": "#/components/schemas/CurrencyCode"
          },
          "benchmark": {
            "$ref": "#/components/schemas/Benchmark"
          },
          "fixed_interet_rate": {
            "$ref": "#/components/schemas/FixedInterestRate"
          },
          "margin_rate": {
            "$ref": "#/components/schemas/MarginRate"
          },
          "margin": {
            "$ref": "#/components/schemas/Margin"
          },
          "fee_processing_code": {
            "$ref": "#/components/schemas/FeeProcessingCode"
          },
          "accrual_basis": {
            "$ref": "#/components/schemas/AccrualBasis"
          },
          "interest_type": {
            "$ref": "#/components/schemas/InterestType"
          },
          "capitalization_frequency": {
            "$ref": "#/components/schemas/CapitalizationFrequency"
          },
          "accrual_frequency": {
            "$ref": "#/components/schemas/AccrualFrequency"
          }
        }
      },
      "InterestPlanId": {
        "type": "string",
        "format": "UUID",
        "description": "Interest plan ID generated during the plan's creation. Must be an alphanumeric UUID with the alphabetical characters in lowercase.",
        "example": "07d84f79-3027-47bd-b628-65528ccc8fb2"
      },
      "InterestType": {
        "type": "string",
        "description": "Interest calculation type\n- `SIMPLE`: Calculated on the original deposit or investment value.\n- `COMPOUND`: Calculated on the original value plus the last accumulated interest.\n",
        "enum": [
          "SIMPLE",
          "COMPOUND"
        ],
        "example": "SIMPLE"
      },
      "Margin": {
        "type": "number",
        "format": "double",
        "description": "Also known as a spread, this is an incremental rate the clients receive on investments or deposits. \nIf a `benchmark` value is provided, this field is optional.\nIf `benchmark` is null, this field must be null also.\n",
        "example": 0.02
      },
      "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
      },
      "OrgId": {
        "type": "string",
        "description": "Organization ID generated in the onboarding process",
        "example": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
      }
    },
    "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/plan/{interestPlanId}": {
      "get": {
        "summary": "Get interest plan",
        "description": "Get interest plan details. By default, returns the latest version of the interest plan.\nYou can optionally specify a `version_date` query parameter to retrieve the version that was active on a specific date.\nIf a `version_date` is provided, the endpoint returns the latest version with a start date less than or equal to the specified date.\n",
        "tags": [
          "Interest engine"
        ],
        "operationId": "get-v1-interest-plan",
        "parameters": [
          {
            "$ref": "#/components/parameters/Authorization"
          },
          {
            "$ref": "#/components/parameters/InterestPlanIdPath"
          },
          {
            "$ref": "#/components/parameters/VersionDate"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetInterestPlanResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/404NotFound"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```