Sign in

v1

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

Create savings account product

Create an organization's savings account product. Savings account products accrue interest based on the balance at the time of the interest calculation.<br> This endpoint generates the Savings account product created event. For information about interest-bearing accounts, see Interest-bearing accounts.

post/v1/savings-accounts

Headers

AuthorizationTokenstring required

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

Request body

interest_plan_idstring required

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

namestring required

The product name.

min_amountnumber

Minimum amount for yield. If balance is below this value, yield is not calculated. If no value is provided, any available amount is treated as accrued interest.

start_datestring date

Defines the earliest date from which the product can be attached to an account or program. Attach operations attempted before this date are rejected. Date is displayed in UTC.

metadataobject

The metadata object contains user-defined key-value pairs that provide additional context or custom information.<br> The platform has no control over its content, but rather 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 request

{
  "interest_plan_id": "263d509a-d5d0-4b3a-b909-ce1b9174beff",
  "name": "Tax 1 Default",
  "min_amount": 1000,
  "processing_codes": {
    "interest_processing_code": "009797",
    "detach_processing_code": "009696"
  },
  "start_date": "2025-11-01",
  "metadata": {
    "key": "value"
  }
}

Response

Success

created_atstring datetime

The moment when a product is created.

updated_atstring datetime

The moment when a product is updated.

interest_plan_idstring

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

namestring

The product name.

min_amountnumber

Minimum amount for yield. If balance is below this value, yield is not calculated. If no value is provided, any available amount is treated as accrued interest.

product_idstring

Product identifier.

product_type'deposit' | 'savings-account'

Product type.

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

Product status

start_datestring date

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

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",
  "updated_at": "2024-01-23T13:26:25.000Z",
  "interest_plan_id": "263d509a-d5d0-4b3a-b909-ce1b9174beff",
  "name": "Tax 1 Default",
  "min_amount": 1000,
  "processing_codes": {
    "interest_processing_code": "009797",
    "detach_processing_code": "009696"
  },
  "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
  "status": "ACTIVE",
  "start_date": "2025-11-01",
  "metadata": {
    "key": "value"
  }
}