Interest engine

List Org interest plans

List all interest plans for a given Org.

get/v1/interest/plan

Request

  • Base URL
    https://sandbox.pismolabs.io/interest-engine
  • URL
    https://sandbox.pismolabs.io/interest-engine/v1/interest/plan
  • Auth
    HTTP bearer

Query parameters

pageinteger required

Page number. Default is 1.

perPageinteger required

Number of items per page. Default is 10.

Response

OK

current_pageinteger

Current page

per_pageinteger

Number of items per page. Default is 10.

pagesinteger

Total number of pages. Default is 1.

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "per_page": 1,
  "pages": 1,
  "total_items": 1,
  "items": [
    {
      "interest_plan_id": "07d84f79-3027-47bd-b628-65528ccc8fb2",
      "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
      "description": "Banking plan",
      "currency_code": "986",
      "benchmark": "FIXED",
      "fixed_interest_rate": 0.1,
      "margin_rate": 1.1,
      "margin": 0.02,
      "tax_withholding": {
        "withholding_moment": "ACCRUAL",
        "fee_processing_code": "001100",
        "tax_rules": [
          {
            "description": "IOF",
            "fixed_percentage": 0.0038
          }
        ]
      },
      "accrual_basis": "ACTUAL/365",
      "interest_type": "SIMPLE",
      "capitalization_frequency": "DAILY",
      "accrual_frequency": "DAILY",
      "status": "ACTIVE",
      "operation_type": "DEBIT",
      "start_date": "2024-09-10",
      "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
      },
      "division_id": "d9b2c9e1-4633-4a10-841b-270f7f1493cd",
      "interest_base_model": "CLOSING-BALANCE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.