Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Product

Get deposit product

Get deposit product by product ID. Note that product ID is Pismo-generated.

get/v1/deposits/{productId}

Path parameters

productIdstring required

Product ID

Headers

AuthorizationTokenstring required

Account token. Token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

Response

Success

cool_off_periodinteger

Period in days when a withdrawal can be made without penalty.

created_atstring datetime

Date and time the product was created

funding_durationinteger

Period during which money is allowed to deposit into the account before the account is blocked. The value of this field is calculated in days.

interest_plan_idstring

Interest rate plan ID. This corresponds to the ID you created using the Create interest plan version) endpoint.

min_amountnumber

The minimum balance required to earn yield. If the balance is below this amount, yield is not calculated, and if no value is specified, any available amount is treated as accrued interest.

max_amountnumber

Maximum deposit amount.

min_terminteger

Minimum term duration. The value of this field is calculated in days.

max_terminteger

Maximum term duration. The value of this field is calculated in days.

grace_period_duration_daysinteger

The number of days in the grace period. Withdrawals are allowed during this period. This field applies only if no grace period penalty is defined and penalties do not apply.

namestring

Product name

product_idstring

Product identifier.

product_type'deposit' | 'savings-account'

Product type

status'CREATED' | 'ACTIVE' | 'INACTIVE'

Indicates the current state of the product. For example, CREATED.

term_type'FIXED' | 'FLEXIBLE'

Term type. For example, FIXED or FLEXIBLE.

start_datestring date

Defines the earliest date from which the product can be attached to an account or program. Date is displayed in UTC.

end_datestring date

Defines the final date when the product can be attached to an account or program, rejects any attach operations submitted after that date, uses the yyyy‑mm‑dd format with all dates shown in UTC+0 regardless of your timezone, and must be set at least one day after the current date (D+1).

metadataobject

The metadata object contains user-defined key-value pairs that provide additional context or custom information.<br> Metadata content is not controlled by the Pismo platform and is instead controlled by the user.<br>

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

Example response

{
  "created_at": "2024-01-23T13:26:25.000Z",
  "funding_duration": 12,
  "interest_plan_id": "263d509a-d5d0-4b3a-b909-ce1b9174beff",
  "maturity_instructions": {
    "principal": "ROLLOVER",
    "interest": "PAY"
  },
  "min_amount": 1000,
  "max_amount": 5000,
  "min_term": 265,
  "max_term": 1025,
  "grace_period_duration_days": 30,
  "name": "Tax 1 Default",
  "penalties": {
    "early_withdrawal_after_opening": {
      "applicable_within_days": 30,
      "penalty_interest_days": 90
    },
    "grace_period": {
      "duration_days": 7,
      "penalty_interest_days": 30
    },
    "tiered_interest_forfeiture": [
      {
        "min_days_held": 1,
        "max_days_held": 90,
        "forfeited_interest_days": 30
      }
    ],
    "withdrawal_fee": {
      "type": "PERCENTAGE",
      "value": 1.5
    },
    "subsequent_withdrawals": {
      "applicable_within_days": 30,
      "window_behavior": "ROLLING",
      "penalty_interest_days": 7
    }
  },
  "notices": [
    {
      "days_before_maturity": 30,
      "description": "30-day advance notice"
    }
  ],
  "processing_codes": {
    "interest_processing_code": "009797",
    "detach_processing_code": "009696"
  },
  "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
  "status": "CREATED",
  "term_type": "FIXED",
  "start_date": "2025-11-01",
  "end_date": "2027-12-31",
  "metadata": {
    "key": "value"
  }
}