APIs
Sub-processorsAbout PismoContact us

Create deposit product

post
https://sandbox.pismolabs.io/savings-products/v1/deposits

Create an organization's time deposit accounts. Time deposit accounts, such as CDs, require you to keep your funds in the account for a mutually agreed amount for a specific period of time.
This endpoint generates the Deposit product created event. For information about interest-bearing accounts, refer to 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

The product name.

string
required

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

string
enum
required

Term type. For example, FIXED or FLEXIBLE.

Allowed:
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-CHANGE → DEPOSIT_BASIS or CLOSING-BALANCE → BALANCE_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:
maturity_instructions
object
  • If the principal or interest are ROLLOVER, the respective amounts is rolled over to a new deposit term.
  • If the principal is NO_ACTION, no action is taken with the principal amount at maturity.
  • If the interest is PAY and the accrued interest is greater than zero, it's paid to the account's cash balance.
processing_codes
object
integer

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

integer

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.

int32

Number of days during which changes can be made to the product before it rolls over. If you define a grace period penalty, configure it under penalties.grace_period. The grace‑period expiration is scheduled according to the account’s division timezone, using the parent division’s timezone when available, or UTC when no division timezone is defined. There is no enforced minimum or maximum; any positive integer is accepted.

boolean
Defaults to true

Controls whether interest continues to accrue during the post‑maturity grace period. When set to true (the default), the Pismo platform submits daily accruals to the interest engine. When set to false, those submissions stop. If the field is omitted or null, it is treated as true. Note that this setting does not change the grace‑period lifecycle.

number

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.

number

Maximum deposit amount.

integer

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

integer

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

penalties
object

Set of penalty configurations that can be applied to a deposit product. Each penalty type corresponds to a specific fee ID and transaction flow within the Pismo platform. For details about penalty types, refer to the Penalty types section of Penalties for CD accounts.

notices
array of objects
length ≤ 3

Advance maturity notice configurations for deposit products only, rejected for savings‑account products. If this field is included in a savings‑account request, the API returns HTTP 400. When provided, the field must contain one to three entries, each with a unique days_before_maturity value. If the field is absent or the array is empty, no notices are configured.

notices
date

Define 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.

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).

metadata
object

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

Updated 5 months ago

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

Updated 5 months ago

Did this page help you?