PIpismo
Product

Update deposit product

Update deposit by product ID. Note that product ID is Pismo-generated.<br> This endpoint generates the Deposit product updated event.

patch/v1/deposits/{productId}

Request

  • Base URL
    https://sandbox.pismolabs.io/savings-products
  • URL
    https://sandbox.pismolabs.io/savings-products/v1/deposits/{productId}
  • Auth
    HTTP bearer

Path parameters

productIdstring required

Product ID

Request body

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

Product status

reasonstring

Status update reason. Required when status is provided.

min_amountnumber

The minimum balance required to earn yield. When provided, must be greater than 0. Applied from the moment of a successful update (Not retroactive. Accounts already opened are not revalidated).

accrue_during_grace_periodboolean

Controls whether interest accrual continues during the post‑maturity grace period. Applies only to deposit products. The value is read live and takes effect on the next daily cycle. It does not alter the grace‑period lifecycle.

Example request

{
  "status": "ACTIVE",
  "reason": "Activating product",
  "min_amount": 50,
  "notices": [
    {
      "days_before_maturity": 60,
      "description": "Updated single 60-day notice"
    }
  ]
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.