v1
latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MBInterest engine
List Org interest plans
List all interest plans for a given Org.
get/v1/interest/plan
Query parameters
pageinteger required
Page number. Default is 1.
perPageinteger
Example:10
Maximum number of items per page
Headers
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.
Response
OK
Example response
{
"current_page": 1,
"per_page": 15,
"pages": 10,
"total_items": 100,
"items": [
{
"interest_plan_id": "07d84f79-3027-47bd-b628-65528ccc8fb2",
"org_id": "TN-34778262-f4f0-464d-b4c6-a14exxxxxxxx",
"description": "Challenge expired",
"currency_code": "840",
"benchmark": "FED",
"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,
"threshold_amount": 1000
}
]
},
"accrual_basis": "ACTUAL/365",
"interest_type": "SIMPLE",
"capitalization_frequency": "DAILY",
"accrual_frequency": "DAILY",
"status": "PENDING",
"operation_type": "DELETE",
"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"
}
]
}