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.
This endpoint generates the Savings account product created event. For information about interest-bearing accounts, see Interest-bearing accounts. The interest plan is fetched once and used to resolve or validate accrual_model before any resource configuration. Missing, null, or empty values derive the model from the plan. An explicit mismatch returns HTTP 400 EIBACC0365. An unknown nonempty plan model or a missing plan object returns HTTP 500 EIBACC0007, and errors from the interest plan API are passed through. None of these failures configure resources, persist a product, or publish a creation event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

string
required

The product name.

string | null
enum

Defines the balance basis for daily interest accrual:

  • DEPOSIT_BASIS: Net daily balance change (credits minus debits), determined at the end of the day.
  • BALANCE_BASIS: Daily closing balance.

If not provided (omitted, null, or empty string ""), the value is derived from the interest plan: BALANCE-CHANGEDEPOSIT_BASIS or CLOSING-BALANCEBALANCE_BASIS. An explicit value must match the plan; otherwise, the request returns a 400 error: EIBACC0365.

If the plan's interest_base_model is missing, null, or empty, the Pismo platform treats it as CLOSING-BALANCE, which produces BALANCE_BASIS when the request does not set accrual_model.

Allowed:
string
enum
Defaults to VALUE_DATED_BALANCE

Which balance of the balance_history event is submitted when accrual_model is BALANCE_BASIS. VALUE_DATED_BALANCE uses the cleared balance (default). LEDGER_BALANCE includes uncleared funds.

Allowed:
float

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.

processing_codes
object
required
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.

metadata
object

The metadata object contains user-defined key-value pairs that provide additional context or custom information.
The platform has no control over its content, but rather controlled by the user.

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.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json