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/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/deposits/{productId}
  • Auth
    none declared. Required headers: AuthorizationToken

Path parameters

productIdstring required

Product ID

Headers

AuthorizationTokenstring required

Generic token. Token encoded with a generic token ID. Tokens can expire quickly, which can result in a 401 Unauthorized error.

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

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.