v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Account interest

Get account interest

Get account interest details.

get/v1/interest/account/{accountId}

Path parameters

accountIdstring required

Account ID

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

benchmark'BOE' | 'DI' | 'FED' | 'RBA' | 'RBI' | 'TO'

Market index used to measure interest value over time. For fixed interest, this field must be null.

  • BOE: Bank of England, UK
  • DI: Interbank Deposit Contract, Brazil
  • FED: Federal Reserve System, USA
  • RBA: Reserve Bank of Australia
  • RBI: Reserve Bank of India
  • TO: Overnight Interbank Target Rate (Tasa Objetivo), Mexico
fixed_interest_ratenumber float

Fixed annual interest rate for investments or deposits. If a benchmark value is provided, this field must be null.

margin_ratenumber double

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.

marginnumber double

Also known as a spread, this is an incremental rate the clients receive on investments or deposits. If a benchmark value is provided, this field is optional. If benchmark is null, this field must be null also.

taxes_exemptionboolean

Is the account exempt from taxes?

capitalization_frequency'DAILY' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'MATURITY'

Interest payout frequency

Example response

{
  "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
      }
    ]
  },
  "taxes_exemption": true,
  "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
      }
    ]
  },
  "capitalization_frequency": "DAILY"
}