Product

List products

Return a list of an organization's savings and time-deposit accounts.

get/v1/products

Request

Base URL
https://sandbox.pismolabs.io/savings-products
URL
https://sandbox.pismolabs.io/savings-products/v1/products
Auth
HTTP bearer

Query parameters

beginDatetimestring date-time

Queries for the date and time of products after the value of this field. Date and time are displayed in RFC 3339 format, for example: 2024-01-28T10:33:01Z.

endDatetimestring date-time

Queries for the date and time of products created before the value of this field. Date and time are displayed in RFC 3339 format, for example: 2024-01-29T10:33:01Z.

afterIdinteger

This is the last_id field returned in the response which you can use to get the next result set. This is displayed in UNIX timestamp.

perPageinteger

Number of items per page.

order'ASC' | 'DESC'

List result order of the created_at value. It can be sorted in ascending (ASC) or descending (DESC) order. Default is DESC.

orderBy'created_at' | 'name'

Field used to sort the result. It can be either created_at or name. Default is created_at.

productType'deposit' | 'savings-account'

Filter results by product type.

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

Filter results by status.

namestring

Filter results by product name using a substring match, regardless of letter case.

productIdstring uuid

Filter by product ID. If specified, the request ignores name, pagination, and ordering parameters; only productType, status, and the date range are applied in addition to the product ID filter. The response contains at most one product, and next_page is set to false.

Response

Success

last_idinteger

Pagination reference, displayed in UNIX timestamp.

next_pageboolean

Indicates whether there is a next page of results.

per_pageinteger

Number of items per page. Default 20, maximum is 100.

Example response

{
  "last_id": 1706027185000,
  "next_page": true,
  "per_page": 20,
  "items": [
    {
      "created_at": "2024-01-23T13:26:25.000Z",
      "updated_at": "2024-01-23T13:26:25.000Z",
      "funding_duration": 12,
      "interest_plan_id": "263d509a-d5d0-4b3a-b909-ce1b9174beff",
      "maturity_instructions": {
        "principal": "ROLLOVER",
        "interest": "PAY"
      },
      "min_amount": 1000,
      "max_amount": 5000,
      "min_term": 265,
      "max_term": 1025,
      "grace_period_duration_days": 30,
      "accrue_during_grace_period": true,
      "name": "Tax 1 Default",
      "penalties": {
        "early_withdrawal_after_opening": {
          "applicable_within_days": 30,
          "penalty_interest_days": 90
        },
        "grace_period": {
          "duration_days": 7,
          "penalty_interest_days": 30
        },
        "tiered_interest_forfeiture": [
          {
            "min_days_held": 1,
            "max_days_held": 90,
            "forfeited_interest_days": 30
          }
        ],
        "withdrawal_fee": {
          "type": "PERCENTAGE",
          "value": 1.5
        },
        "subsequent_withdrawals": {
          "applicable_within_days": 30,
          "window_behavior": "ROLLING",
          "penalty_interest_days": 7
        }
      },
      "notices": [
        {
          "days_before_maturity": 30,
          "description": "30-day advance notice"
        }
      ],
      "processing_codes": {
        "interest_processing_code": "009797",
        "detach_processing_code": "009696"
      },
      "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
      "status": "CREATED",
      "term_type": "FIXED",
      "accrual_model": "DEPOSIT_BASIS",
      "balance_type": "VALUE_DATED_BALANCE",
      "start_date": "2025-11-01",
      "end_date": "2027-12-31",
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

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